Documentation – ARGOS
Ce document décrit le fonctionnement de la documentation du projet ARGOS à l’aide de Doxygen et de CMake.
La documentation est optionnelle, désactivée par défaut, et générée uniquement à la demande.
Prérequis
- Doxygen installé sur la machine
- Windows : installer Doxygen (lien)
- Linux :
sudo apt install doxygen - Vérification :
doxygen --version
Aucune dépendance Doxygen n’est embarquée dans le projet.
Activation de la documentation
Pour activer la documentation lors de la configuration :
cmake -S . -B out -DBUILD_DOC=ON
Génération de la documentation
Une fois la configuration effectuée, la documentation est générée via une cible dédiée :
cmake --build out --target doc
Emplacement de la documentation générée
La documentation HTML est générée dans le dossier de build :
out/<CONFIG>/doc/html/index.html
- <CONFIG> peut ne pas apparaitre
Contenu de la documentation
La documentation est générée à partir des dossiers :
- include/
- src/
Les fichiers pris en compte sont :
- *.h
- *.hpp
- *.cpp
La génération est récursive sur l’ensemble de l’arborescence.
Règles à respecter pour documenter le code
cf. lien doc
Pour que les éléments apparaissent correctement dans la documentation :
- Utiliser des commentaires compatibles Doxygen :
///pour les commentaires simples/** ... */pour les blocs