Documentation automatique de code

Le programme doxygen sert à générer automatiquement des pages html de documentation de code. Il se base sur des commentaires écrits dans une certaine syntaxe. Par exemple la documentation de la librairie inf111 a été générée grace aux commentaires insérés dans les fichiers de déclarations logo.h et hasard.h.

Kdevelop fait appel à doxygen quand on sélectionne Build->Build API documentation. Par défaut la documentation se retrouve dans html/index.html sous le répertoire racine du projet. On peut ouvrir cette page avec n'importe quel navigateur.

Doxygen est configurable au moyen du programme doxywizard que kdevelop exécute quand on sélectionne Project->Project options...->Doxygen
Quelques modifications possibles des paramètres par défaut:

• cocher Project->optimize output for C quand on programme en C
• cocher Source Browser->Cross-reference with source files quand on veut consulter facilement les programmes à partir de la documentation
• cocher Index->Generate alphabetical index et réduire le nombre de colonnes à 1 pour faciliter la recherche dans une longue liste
• décocher LaTeX->Generate LaTeX et XML->Generate XML si on n'utilise pas la documentation sous ces formats