Doxygen. 2 Doxygen : qu’est-ce que c’est ? Système de documentation pour programmes –C++, Java, Objective-C, IDL –PHP, C# Génère automatiquement : –Html,

Présentation au sujet: "Doxygen. 2 Doxygen : qu’est-ce que c’est ? Système de documentation pour programmes –C++, Java, Objective-C, IDL –PHP, C# Génère automatiquement : –Html,"— Transcription de la présentation:

1 Doxygen

2 2 Doxygen : qu’est-ce que c’est ? Système de documentation pour programmes –C++, Java, Objective-C, IDL –PHP, C# Génère automatiquement : –Html, Xml, Latex, Pdf, PS –man pages –graphe des dépendances, des héritages Couplage fort entre la documentation et le code

3 3 Doxygen : comment ? … sans rien faire ;-) Exemple : –lien DrawQt du menu principal Génère automatiquement la documentation –en s’appuyant sur un fichier de configuration, qu’il est capable de générer sous forme de template $> doxygen -g configFile –en analysant le code –en analysant les commentaires placés dans le code, selon un format spécifique

4 4 Doxygen : 1ère bouffée (1) Au début de chaque fichier, juste après les instructions d’inclusion : #include /** @file nomDuFichier.ext * @brief Une brève description du fichier. * * Une description plus complète du fichier. * Probablement sur plusieurs lignes. */

5 5 Doxygen : 1ère bouffée (2) Juste avant chaque classe : /** @brief Une brève description de maClasse. * * Une description plus complète de maClasse. * Probablement sur plusieurs lignes. */ class maClass {

6 6 Doxygen : 1ère bouffée (3) Juste avant chaque méthode : /** @brief Une brève description de maMethode. * * Une description plus complète de maMethode. * Probablement sur plusieurs lignes. * @param unArgument Une brève description de unArgument. * @return Une brève description de ce que retourne * maMethode. */ std::string maMethode( std::string unArgument );

7 7 Doxygen : 1ère bouffée (4) Juste avant chaque variable : /** @brief Une brève description de maVariable. * * Une description plus complète de maVariable. * Probablement sur plusieurs lignes. */ std::string maVariable;

8 8 Doxygen : en apnée (1) Au début de chaque fichier, juste après les instructions d’inclusion : #include /** @file nomDuFichier.ext * @brief Une brève description du fichier. * * Une description plus complète du fichier. * Probablement sur plusieurs lignes. * * Exemple * Status maFonction(); * * @author Leroi Arthur */

9 9 Doxygen : en apnée (2) Juste avant chaque classe : /** @brief Une brève description de maClasse. * * Une description plus complète de maClasse. * Probablement sur plusieurs lignes. * Une liste de caractéristiques : * - un item * -# numéroté 1 * -# numéroté 2 * - un autre item */ class maClass {

10 10 Doxygen : en apnée (3) Juste avant chaque méthode : /** @brief Une brève description de maMethode. * * Une description plus complète de maMethode. * Probablement sur plusieurs lignes. * * @param unArgument Une brève description de unArgument. * @return Une brève description de ce que retourne * maMethode. * * @throws monException La raison et la description. * * @see #uneAutreMethode * @see uneAutreClasse#uneAutreMethode */ std::string maMethode( std::string unArgument );

11 11 Doxygen : syntaxe des liens @see package Lien vers un package @see classname Lien vers classname dans le package courant @see package.classname Lien vers classname dans un autre package @see #method Lien vers method dans la classe courante @see classname#method Lien vers method dans une autre classe @see #method(type) Lien vers method avec l’argument type

12 12 Doxygen : en apnée (4) Enrichir la page d’introduction : @mainpage –dans un bloc de commentaire –par exemple, dans un fichier mainpage.h /** @mainpage Le package Test * * @section intro Introduction * … * @section install Procédure d’installation … * @subsection step_1 Première étape … * @subsection step_2 Deuxième étape … * … * Le fichier ChangeLog */

13 13 Utilisation avec CMT Dans / /cmt : $> cmt make doxygen puis : $> open../doc/html/index.html … c’est tout … ;-)