Documentation – ARGOS
This document describes how the documentation for the ARGOS project works using Doxygen and CMake.
The documentation is optional, disabled by default, and generated only on demand.
Prerequisites
- Doxygen installed on the machine
- Windows : install Doxygen (link)
- Linux :
sudo apt install doxygen - Verification: No Doxygen dependencies are included in the project.
Enabling Documentation
To enable documentation during configuration:
Generating the documentation
Once the configuration is done, the documentation is generated via a dedicated target:
Location of the generated documentation
The HTML documentation is generated in the build folder:
out/<CONFIG>/doc/html/index.html
- <CONFIG> may not appear
Documentation content
The documentation is generated from the following folders:
- include/
- src/
The files included are:
- *.h
- *.hpp
The generation is recursive across the entire directory tree.
Rules to follow when documenting code
cf. doc link
To ensure elements appear correctly in the documentation:
- Use Doxygen-compatible comments:
///for simple comments/** ... */for block comments