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 | ||
doxygen [Le 15/08/2020, 01:18] Bissap [Liens] Mise à jour des liens brisés |
doxygen [Le 10/03/2023, 22:22] (Version actuelle) L'Africain |
||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
- | {{tag>Trusty xenial programmation java}} | + | {{tag>Jammy programmation java}} |
---- | ---- | ||
+ | {{ :doxygen.png?150}} | ||
======= 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 : | + | |
+ | **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 : | + | |
- | * Disposer des [[:sudo|droits d'administration]] ; | + | * [[:tutoriel:comment_installer_un_paquet|Installez les paquets]] **[[apt>doxygen,doxygen-gui,doxygen-doc|doxygen doxygen-gui doxygen-doc]]**. |
- | * Avoir une connexion internet activée et opérationnelle ; | + | |
- | * [[:tutoriel:comment_installer_un_paquet|Installez les paquets]] **[[apt://doxygen,doxygen-gui,doxygen-doc|doxygen doxygen-gui doxygen-doc]]**. | + | |
===== Utilisation ===== | ===== Utilisation ===== | ||
==== Interface graphique ==== | ==== Interface graphique ==== | ||
- | Ouvrez un terminal et entrez la commande suivante : | + | 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 |