Book Image

CMake Best Practices

By : Dominik Berner, Mustafa Kemal Gilor
5 (2)
Book Image

CMake Best Practices

5 (2)
By: Dominik Berner, Mustafa Kemal Gilor

Overview of this book

CMake is a powerful tool used to perform a wide variety of tasks, so finding a good starting point for learning CMake is difficult. This book cuts to the core and covers the most common tasks that can be accomplished with CMake without taking an academic approach. While the CMake documentation is comprehensive, it is often hard to find good examples of how things fit together, especially since there are lots of dirty hacks and obsolete solutions available on the internet. This book focuses on helping you to tie things together and create clean and maintainable projects with CMake. You'll not only get to grips with the basics but also work through real-world examples of structuring large and complex maintainable projects and creating builds that run in any programming environment. You'll understand the steps to integrate and automate various tools for improving the overall software quality, such as testing frameworks, fuzzers, and automatic generation of documentation. And since writing code is only half of the work, the book also guides you in creating installers and packaging and distributing your software. All this is tailored to modern development workflows that make heavy use of CI/CD infrastructure. By the end of this CMake book, you'll be able to set up and maintain complex software projects using CMake in the best way possible.
Table of Contents (22 chapters)
Part 1: The Basics
Part 2: Practical CMake – Getting Your Hands Dirty with CMake
Part 3: Mastering the Details

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 also 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...