Automatically Generating Documentation
Documentation is—without a doubt—an essential part of all projects. Documentation conveys information that is not implicitly available to the user. It is a way of sharing the intent, functionality, capabilities, and restrictions regarding a project and it enables both technical and non-technical people to work on a project. However, it is indeed a time-consuming process to write documentation. Thus, it is crucial to make use of the tools available for generating documentation.
This chapter will show you ways of integrating Doxygen, dot, and PlantUML into CMake to speed up the documentation process. These tools will let us lessen the context switch between code and documentation and ease the maintenance burden of documentation.
To understand the skills shared in this chapter, we’ll cover the following main topics:
- Generating documentation from your code
- Packaging and distributing documentation with CPack ...
