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 Dernière révision Les deux révisions suivantes | ||
doxygen [Le 26/03/2016, 07:37] bcag2 ajout extensions graphViz pour les graphes |
doxygen [Le 11/09/2022, 11:39] moths-art Suppression des espaces en fin de ligne (détecté et corrigé via le bot wiki-corrector (https://forum.ubuntu-fr.org/viewtopic.php?id=2067892) |
||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
- | {{tag>Trusty programmation java}} | + | {{tag>Trusty xenial programmation java}} |
---- | ---- | ||
Ligne 8: | Ligne 8: | ||
{{:doxygen.png?150 }} | {{:doxygen.png?150 }} | ||
- | **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 documentation 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. | ||
Ligne 17: | Ligne 17: | ||
===== Installation ===== | ===== Installation ===== | ||
- | Pré-requis : | + | Pré-requis : |
* Disposer des [[:sudo|droits d'administration]] ; | * Disposer des [[:sudo|droits d'administration]] ; | ||
* Avoir une connexion internet activée et opérationnelle ; | * Avoir une connexion internet activée et opérationnelle ; | ||
Ligne 23: | Ligne 23: | ||
===== 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. | ||
- | Le bouton wizard vous permet | + | Le bouton wizard vous permet |
* de créer votre projet | * de créer votre projet | ||
* de sélectionner le dossier contenant les sources ou celui accueillant votre documentation | * de sélectionner le dossier contenant les sources ou celui accueillant votre documentation | ||
Ligne 38: | 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 ===== | ===== 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.\\ | 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.\\ | ||
- | [[http://touticphoto.fr/developpement/48-documenter-un-projet-avec-graphes-avec-doxygen-et-graphviz|Article pour aller plus loin]] | + | [[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]] | + | * **(en)** Page officielle de [[https://www.doxygen.nl/index.html|Doxygen]] |
- | * Tous les [[http://www.stack.nl/~dimitri/doxygen/output.html|formats de sortie]] possibles | + | * **(en)** Tous les [[https://www.doxygen.nl/manual/output.html|formats de sortie]] possibles |
- | * [[http://www.stack.nl/~dimitri/doxygen/results.html|Quelques exemples]] de documentation générés à partir de Doxygen | + | * **(en)** [[https://www.doxygen.nl/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 | + | * **(en)** La longue liste des [[https://www.doxygen.nl/projects.html|projets connus]] utilisant Doxygen |
----- | ----- | ||
//Contributeurs : [[utilisateurs:poupoul2]], [[utilisateurs:bcag2]]// | //Contributeurs : [[utilisateurs:poupoul2]], [[utilisateurs:bcag2]]// |