Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
doxygen [Le 13/11/2008, 23:24]
jahwork typo
doxygen [Le 15/08/2020, 01:18] (Version actuelle)
Bissap [Liens] Mise à jour des liens brisés
Ligne 1: Ligne 1:
-{{tag>Dapper Gutsy Hardy Intrepid Développement Java Python BROUILLON}}+{{tag>Trusty xenial programmation java}}
  
 ---- ----
Ligne 6: Ligne 6:
  
 ======= Doxygen ====== ======= Doxygen ======
 +{{:​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 : 
 +  * à 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. ​
  
-**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.+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.
- 
- 
 ===== Installation ===== ===== Installation =====
  
 Pré-requis :  Pré-requis : 
-  * Disposer des 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 ​doxygendoxygen-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 31: Ligne 34:
   * de générer des diagrammes   * de générer des diagrammes
  
-Le bouton Expert vous permet d'​accéder aux options avancées+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. 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. 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]] +  ​* **(en)** Page officielle de [[https://​www.doxygen.nl/index.html|Doxygen]] 
-  * [[http://www.stack.nl/~dimitri/​doxygen/​results.html|Quelques ​résultats]] obtenus via Doxygen +  * **(en)** Tous les [[https://www.doxygen.nl/manual/output.html|formats de sortie]] possibles 
-  * La longue liste des [[http://www.stack.nl/​~dimitri/​doxygen/​projects.html|projets connus]] utilisant Doxygen +  * **(en)** [[https://​www.doxygen.nl/​results.html|Quelques ​exemples]] de documentation générés à partir de Doxygen 
-----+  ​* **(en)** La longue liste des [[https://www.doxygen.nl/​projects.html|projets connus]] utilisant Doxygen 
 + 
 +-----
  
-//​Contributeurs : [[utilisateurs:​poupoul2]]//​+//​Contributeurs : [[utilisateurs:​poupoul2]], [[utilisateurs:​bcag2]]//
  • doxygen.1226615076.txt.gz
  • Dernière modification: Le 18/04/2011, 14:53
  • (modification externe)