Documentation du code

Doxygen

Doxygen est un système de documentation pour C, C++, Java, Python, Php et autres langages. Il permet de générer la documentation de vos développements :

  • à partir des commentaires insérés dans le code source
  • à défaut de commentaires, à partir de la structure du code lui même. La documentation générée sera dans ce cas minimale.

La documentation peut être produite dans des formats variés tels que du HTML, du Latex, du RTF ou du XML.

Doxygen est un logiciel libre, publié sous licence GPL V2.0.

Lire : doc.ubuntu-fr.org/doxygen

Installation

Ubuntu :

$ sudo apt-get install doxygen doxygen-gui doxygen-doc

Pour les graphiques :

$ sudo apt-get install graphviz

Utilisation

Pour lancer l’interface graphique de Doxygen, ouvrez un terminal et entrez la commande suivante :

doxywizard

L’onglet wizard vous permet :

  • de créer votre projet
  • de sélectionner le dossier contenant les sources ou celui accueillant votre documentation
  • de sélectionner le format de sortie : HTML avec ou sans frames, Latex, RTF, pages man, XML, PDF, Postscript.
  • de générer des diagrammes

L’onglet Expert vous permet d’accéder aux options avancées.

Il ne vous reste alors plus qu’à cliquer sur Run pour obtenir le résultat.

Exemple de configuration

Remarques :

  • Sélectionner le Français pour OUTPUT_LANGUAGE
  • Le format HTML est adapté à la navigation et le format PDF est indispensable pour imprimer et avoir l’ensemble de la documentation dans un seul fichier. Le format RTF sera utile pour y faire des copier/coller pour votre dossier.