Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente Prochaine révision Les deux révisions suivantes | ||
doxygen [Le 15/11/2008, 15:07] poupoul2 ajout logo + modifs diverses |
doxygen [Le 10/10/2018, 14:40] 163.116.6.97 [En ligne de commande] typo |
||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
- | {{tag>Dapper Gutsy Hardy Intrepid Développement Java Python BROUILLON}} | + | {{tag>Trusty xenial programmation java}} |
---- | ---- | ||
Ligne 10: | Ligne 10: | ||
**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 : | **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 | * à partir des commentaires insérés dans le code source | ||
- | * à défaut de commentaires, à partir de la structure du code lui même. La dcoumentation générée sera dans ce cas minimale . | + | * à 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. | 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. | Doxygen est un logiciel libre, publié sous licence GPL V2.0. | ||
- | |||
- | ===== Quelques exemples ===== | ||
- | |||
- | |||
===== Installation ===== | ===== Installation ===== | ||
Pré-requis : | Pré-requis : | ||
* Disposer des [[:sudo|droits d'administration]] ; | * Disposer des [[:sudo|droits d'administration]] ; | ||
- | * Avoir une connection internet activée et opérationnelle ; | + | * Avoir une connexion internet activée et opérationnelle ; |
- | * [[:tutoriel:comment_installer_un_paquet|Installez]] **[[apt://doxygen,doxygen-gui,doxygen-doc|les paquets doxygen, doxygen-gui, doxygen_doc]]** ; | + | * [[:tutoriel:comment_installer_un_paquet|Installez les paquets]] **[[apt://doxygen,doxygen-gui,doxygen-doc|doxygen doxygen-gui doxygen-doc]]**. |
===== Utilisation ===== | ===== Utilisation ===== | ||
- | Pour lancer l'interface graphique de Doxygen, ouvrez un terminal et entrez la commande suivante : | + | ==== Interface graphique ==== |
+ | Ouvrez un terminal et entrez la commande suivante : | ||
<code>doxywizard</code> | <code>doxywizard</code> | ||
il ne vous reste plus qu'à [[:raccourci-lanceur|créer un raccourci]] avec cette commande. | il ne vous reste plus qu'à [[:raccourci-lanceur|créer un raccourci]] avec cette commande. | ||
Ligne 42: | Ligne 39: | ||
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. | 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. | ||
+ | |||
+ | ==== En ligne de commande ==== | ||
+ | Il est conseillé de commencer avec le wizard, au moins à fin de créer votre //DoxyFile// (que vous pouvez nommer comme vous le souhaitez). | ||
+ | Ensuite, il suffit de lancer: | ||
+ | <code>doxygen DoxyFile</code> | ||
+ | |||
+ | ===== Extensions ===== | ||
+ | Pour intégrer des graphes de classe, de collaboration... doxygen donne accès, en mode //wizard// à un onglet //diagram//, et en mode //expert// aux paramètres //DOT// qui permet d'utiliser graphViz pour les générer.\\ | ||
+ | [[https://touticphoto.fr/developpement/48-documenter-un-projet-avec-graphes-avec-doxygen-et-graphviz|Article pour aller plus loin]] | ||
===== Liens ===== | ===== Liens ===== | ||
* Page officielle de [[http://www.doxygen.org/|Doxygen]] | * Page officielle de [[http://www.doxygen.org/|Doxygen]] | ||
* Tous les [[http://www.stack.nl/~dimitri/doxygen/output.html|formats de sortie]] possibles | * Tous les [[http://www.stack.nl/~dimitri/doxygen/output.html|formats de sortie]] possibles | ||
- | * [[http://www.stack.nl/~dimitri/doxygen/results.html|Quelques exemples]] de documentation générées à partir de Doxygen | + | * [[http://www.stack.nl/~dimitri/doxygen/results.html|Quelques exemples]] de documentation générés à partir de Doxygen |
* La longue liste des [[http://www.stack.nl/~dimitri/doxygen/projects.html|projets connus]] utilisant Doxygen | * La longue liste des [[http://www.stack.nl/~dimitri/doxygen/projects.html|projets connus]] utilisant Doxygen | ||
- | ---- | ||
- | //Contributeurs : [[utilisateurs:poupoul2]]// | + | ----- |
+ | |||
+ | //Contributeurs : [[utilisateurs:poupoul2]], [[utilisateurs:bcag2]]// |