CMake Best Practices

Chapter 6: Automatically Generating Documentation with CMake

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. But 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 look into ways of integrating Doxygen, DOT, and PlantUML into CMake to speed up the documentation process. These tools will allow us to lessen the context switch between code and documentation and ...