Documentation

Documentation can be generated with doxygen.

This requires doxygen and (optionally) dot. Dot can create visualizations of dependency graphs.

Run doxygen

cmake --build build --target name_of_the_project_docs

Output will be in docs/html

Configuration

Doxygen options can be set in the cmake/doxygen.cmake file. In order to set an option, prepend DOXYGEN_ to it and set it as a cmake variable.

Example:

The doxyfile option javadoc_autobrief can be set with

set(DOXYGEN_JAVADOC_AUTOBRIEF YES)