Doxygen pour créer la documentation des développeurs¶

À partir du moment ou on respecte une certaine syntaxe de commentaire du code, l'outil doxygen peut alors créer automatiquement la documentation technique ... c'est vraiment très pratique !

Installation¶

apt-get install doxygen-gui doxygen graphviz

Si vous utilisez emacs vous pouvez également installer doxymacs en complément ;-)

Exemple de code source¶

/**
 * La classe Time représente un instant.
 * @author Paul Hochon
 */
 class Time {

   /**
    * Constructeur.
    * Fixe l'instant à une valeur précise.
    * @param timemillis Millisecondes écoulées depuis le 1er janvier 1970
    */
   Time(int timemillis) {
     ...
   }

   /**
    * Récupère l'instant actuel.
    * @return Un instant correspondant à l'instant présent
    */
   static Time now() {
     ...
   }
 }

Tags les plus utilisés:¶

• @struct pour documenter une structure C.
• @union pour documenter un union C.
• @enum pour documenter un type énuméré.
• @fn pour documenter une fonction.
• @var pour documenter une variable / un typedef / un énuméré.
• @def pour documenter un #define.
• @typedef pour documenter la définition d'un type.
• @file pour documenter un fichier.
• @namespace pour documenter un namespace.
• @package pour documenter un package Java.
• @interface pour documenter une interface IDL.
• @brief pour donner une description courte.
• @class pour documenter classe.
• @param pour documenter un paramètre de fonction/méthode.
• @warning pour attirer l'attention.
• @author pour donner le nom de l'auteur.
• @return pour documenter les valeurs de retour d'une méthode/fonction.
• @see pour renvoyer le lecteur vers quelque chose (une fonction, une classe, un fichier...).
• @throws pour documenter les exceptions possiblement levées.
• @version pour donner le numéro de version.
• @since pour faire une note de version (ex : Disponible depuis ...).
• @exception pour documenter une exception.
• @deprecated pour spécifier qu'une fonction/méthode/variable... n'est plus utilisée.
• @li pour faire une puce.
• @todo pour faire un To Do (= "à faire")
• @fixme pour faire un Fix Me (= "Réparez-moi").

Source: http://fr.wikipedia.org/wiki/Doxygen

Extraction de la documentation¶

Rien de plus facile: lancez l'assistant et suivez le pas à pas. Vous pouvez même générer de la documentation en français si vous le souhaitez !

doxywizard

Vous pouvez prendre le fichier ci-joint comme fichier de départ pour votre projet (fichier pour aller 5.0 de Jean-Louis Frucot, amélioré par Eric Seigne): fichier Doxyfile joint à cette page wiki. Ensuite vous pouvez passer à l'Intégration de l'aide doxygen dans QT Creator