Contenu | Rechercher | Menus
Selon les tags présents sur cette page, celle-ci est ancienne et ne contient plus d'informations sur une des versions supportées d'Ubuntu.
Apportez votre aide…

Table des matières


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.

Installation

Attention !! le paquet doxywizard est manquant pour karmic koala 9.10 bug signalé sur le launchpad : https://bugs.launchpad.net/ubuntu/+source/doxygen/+bug/447130

Pré-requis :

Utilisation

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

doxywizard

il ne vous reste plus qu'à créer un raccourci avec cette commande.

Le bouton 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

Le bouton Expert vous permet d'accéder aux options avancées.

Le boutons Save vous permet de sauvegarder votre projet de documentation, après configuration.

Il ne vous reste alors plus qu'à cliquer sur Run pour obtenir le résultat. Libre à vous ensuite d'aller personnaliser votre Latex ou d'associer votre CSS à la documentation générée.

Liens


Contributeurs : poupoul2



Le contenu de ce wiki est sous licence : CC BY-SA v3.0