Providing the Documentation

Let's learn how to generate automatic documentation.

The final element of a professional project is, of course, the documentation. It comes in two categories:

  • Technical documentation (interfaces, designs, classes, and files)

  • General documentation (all other not-as-technical documents)

We saw that CMake could generate many technical documents automatically using Doxygen.

Automatic documentation generation

A thing to mention: some projects generate documentation during the build stage and package it with the rest of the project. It's a matter of preference. For this project, we have decided not to do so. We might have a good reason to choose otherwise (such as hosting the documentation online).

The figure shows the overview of the execution flow that is used in this process:

Get hands-on with 1200+ tech skills courses.