2.1.4.3 : La page principale de la documentation Doxygen
La page principale de la documentation contient :
- @mainpage : qui donne une breve description du projet
- Un lien qui pointe vers le rapport de la couverture des tests en html, avec tous les détails des programmes et bibliothèques implémentées
- Un lien qui donne le détail de la couverture des tests mais uniquement en xml. Elle pourra être utilisée avec des programmes comme sonarqube (qui est parfaitement inutile lorsqu'il est mal paramétré)
- Une description plus détaillée du projet qui peut contenir des exemples, des cours, enfin tout ce que vous voulez
Voici notre page principale, mainpage.dox :
1 2 3 4 5 6 7 |
/** @mainpage Simple project to explain how to perform CI with Gitlab
*
* <a href="coverage/cov_report.html">See test coverage detail from gcovr</a><br />
* <a href="coverage/Coverage.xml">See test coverage report</a>
*
* More precise description of the project...
*/
|
Vous pouvez télécharger le fichier mainpage.dox ici.