Providing the Documentation
Explore how to create comprehensive documentation for a professional CMake project. Understand the difference between technical and general documentation, use Doxygen for automated generation, and include essential files like README, LICENSE, and INSTALL to ensure your project is well-documented and maintainable.
We'll cover the following...
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 ...