Doxygen

Un article de Wikipédia, l'encyclopédie libre.
Aller à : navigation, rechercher
Doxygen
Image illustrative de l'article Doxygen

Développeur Dimitri van Heesch et contributeurs
Dernière version 1.8.3.1 (20 janvier 2013) [+/-]
Environnement Mac OS, UNIX, Windows, BSD GNU/Linux
Type Générateur de documentation
Licence GPL
Site web www.doxygen.org

Doxygen est un générateur de documentation sous licence libre capable de produire une documentation logicielle à partir du code source d'un programme. Pour cela, il tient compte de la grammaire du langage dans lequel est écrit le code source, ainsi que des commentaires s'ils sont écrits dans un format particulier.

Le code de Doxygen a été écrit en grande partie par Dimitri van Heesch.

Présentation[modifier | modifier le code]

Doxygen est la contraction de « dox » (« docs », abréviation anglaise de « documents ») et de « gen » (« generator »), « générateur de documentation ».

Doxygen est capable d'analyser des fichiers sources écrits dans les langages C++, Objective C, C#, PHP, C++, Java, Python, IDL, Fortran, VHDL, Tcl et dans une certaine mesure D.

La documentation peut être générée dans l'un ou plusieurs des formats suivants : HTML (compressé ou non), LaTeX, RTF, PostScript, PDF avec hyperliens, et prochainement XML (en cours de développement).

Intérêt[modifier | modifier le code]

En permettant l'intégration de la documentation directement dans le code source, Doxygen permet de favoriser la cohérence entre la documentation et le code et de systématiser le comportement des développeurs afin qu'ils documentent le code qu'ils produisent.

Il est également possible d'extraire de la documentation à partir d’un code source non documenté au préalable, ce qui peut faciliter la compréhension d'un programme dont le code est compliqué.

De nombreux projets, tels que KDE, utilisent Doxygen pour générer la documentation de leur API. KDevelop intègre le support de Doxygen. De nombreux éditeurs de texte proposent des modes ou des scripts pour faciliter l'écriture des commentaires Doxygen et la génération de la documentation.

Les informations suivantes peuvent être extraites des sources :

  • prototype et documentation des fonctions, qu'elles soient locales, privées ou publiques, etc. ;
  • liste des fichiers inclus ;
  • documentation des structures de données ;
  • prototype et documentation des classes et leur hiérarchie ;
  • différents types de graphes : diagrammes de classe, de collaboration, d'appels, d'inclusion, etc. (pour générer certains de ces diagrammes, l'outil gratuit Dot est nécessaire) ;
  • un index de tous les identifiants ;
  • des fichiers sources annotés (par exemple avec les numéros de lignes) et navigables (par exemple avec HTML, avec lequel des identifiants renvoient vers la documentation associée).

Exemple[modifier | modifier le code]

Le code ci-dessous illustre la manière dont Doxygen permet de documenter le code.

/**
* 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() {
        ...
    }
}

Les commentaires du langage cible (ici Java) sont spécialisés pour indiquer à Doxygen qu'il doit les prendre en compte. Ainsi, les commentaires commencent avec /** plutôt que /*. Des balises spécifiques à l'intérieur de ces commentaires sont également interprétées par Doxygen (par exemple : @param).

Dans cet exemple, la rédaction des commentaires utilise le format Javadoc, avec lequel Doxygen est compatible. Doxygen propose son propre format, qui est fonctionnellement équivalent.

Les tags les plus utilisés[modifier | modifier le code]

  • \struct pour documenter une structure C.
  • \union pour documenter une 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 une 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 indiquer un code "à faire".
  • \fixme pour indiquer un code défectueux, "à réparer".

Plate-forme[modifier | modifier le code]

Doxygen est écrit sous Linux et Mac OS, avec un souci affiché de portabilité. Il fonctionne sur la plupart des systèmes Unix et il est disponible en version exécutable sur Microsoft Windows.

DoxyWizard[modifier | modifier le code]

DoxyWizard est une interface graphique permettant de configurer les options de génération de Doxygen et de lancer l'extraction de la documentation. Comme Doxygen, il est disponible sur différentes plates-formes.

Licence[modifier | modifier le code]

Doxygen est publié sous licence GPL.

Voir aussi[modifier | modifier le code]

  • OCamlDoc, outil de génération de documentation pour le langage OCaml, développé par l'INRIA;
  • Sphinx, outil de génération de documentation pour le langage Python, développé par la Python Software Foundation;
  • Javadoc, outil de génération de documentation pour le langage Java, développé par Sun
  • SandCastle, outil de génération de documentation pour les langages .Net, édité par Microsoft
  • XMLDoc, outil open source de génération de documentation pour les langages .Net (en cours de développement)
  • Visdoc, outil de génération de documentation HTML pour le langage ActionScript 2 (AS2) & 3 (AS3) et Java (MAC uniquement)

Lien externe[modifier | modifier le code]