2.1.4 : La documentation
- 2.1.4.1) Le fichier CMakeLists.txt
- 2.1.4.2) Le logo du programme
- 2.1.4.3) La page principale de la documentation Doxygen
La configuration liée à la documentation sera écrite dans le dossier doc de notre projet.
Nous allons générer la documentation de notre projet avec le programme Doxygen. Il a besoin d'une configuration qui lui indique le nom du projet, où sont les sources, les exemples, enfin bref, tout ce qu'il faut pour générer une documentation.
Ce fichier de configuration est appelé Doxyfile. Nous n'allons pas le détailler car il est très long et toutes les options sont documentées (en anglais certes, mais quand même).
Comme il est important de ne pas duppliquer les informations, nous allons utiliser la génération de configuration de CMake. Cela consiste à écrire un fichier et à insérer des variables spéciales qui seront remplacées à la volée par CMake.
Nous allons donc partir du fichier Doxyfile.cmake que vous pouvez le télécharger ici. C'est une configuration où les renseignements suivants sont remplaçables :
- @PROGRAM_NAME@ : le nom du programme
- @PROGRAM_VERSION@ : la version du programme
- @PROGRAM_DESCRIPTION@ : une description du programme
- @PROJECT_LOGO@ : le logo du programme
- @OUTPUT_DOC_DIR@ : le dossier où produire la documentation
Chaque variable créée, comme :
1 |
set(PROGRAM_NAME "TestGitlabCI") |