~aleteoryx/muditaos

ref: sign_test muditaos/doc/generate_doxygen.md -rw-r--r-- 876 bytes
a217eeb3 — Dawid Wojtas [BH-2024] Fix lack of alarm directory after updating software 1 year, 5 months ago

#How to generate documentation using Doxygen

NOTE: doxygen documentation is just another target. Basic targets documentation can be found here. How to setup environment to be able to build the targets is here: quickstart

Fully detailed doxygen documentation can be built locally using Doxygen.

You can build code documentation with the following command:

make doc

If you prefer to build documentation always with all target instead, configure cmake with BUILD_DOC_WITH_ALL option set to ON, e.g.:

cmake -DBUILD_DOC_WITH_ALL=ON . build/

Documentation is generated in the doc/html subdirectory of the build directory. To view it open index.html using a web browser, e.g.:

firefox build/doc/html/index.html