Ceci est une ancienne révision du document !
Doxygen
Doxygen est un système de documentation pour C, C++, Java, Python, Php et autres langages. Il permet de générer automatiquement la documentation technique de vos développements, à partir des sources. 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
Pré-requis :
- Disposer des droits d'administration
- Avoir une connection internet activée et opérationnelle
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'à cliequer 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
- Page officielle de Doxygen
- Quelques résultats obtenus via Doxygen
- La longue liste des projets connus utilisant Doxygen
—-
Contributeurs : poupoul2