Doxygen

Présentation Conventions DoxyWizard
Doxygen
Gilles Maire
2017
Gilles Maire Doxygen 1 / 26

Plan de la formation
1 Présentation
2 Conventions
3 DoxyWizard

Présentation

Rubriques
Principe
IDE

Principe
Principe

Principe
Généralité
La documentation de programmes C ou C++ se fait à l’aide du formateur

Doxygen. Doxygen supporte les langages suivants : C, C++, C#, Objective-C,
IDL, Java, VHDL, PHP, Python, Tcl, Fortran et D
Doxygen peut s’utiliser en version ligne de commande ou en version interface
utilisateur
Au préalable il est nécessaire que les codes C/C++ soient commentés en
respectant un certain nombre de conventions.
Doxygen sait produire les documentations aux formats : HTML, du Latex , du
RTF ou du XML
Le site de Doxygen est disponible à l’adresse
http://www.stack.nl/~dimitri/doxygen/

Principe
Installation
Sous Debian/Ubuntu installer :
apt-get install doxygen doxygen-doc doxygen-gui doxygen-dox graphviz
Sous base redhat
dnf install doxygen doxygen-doc doxygen-gui doxygen-dox graphviz
On peut vouloir installer doxygen-latex si on souhaitre produire la documentation

en format Latex et dérivés PDF, PostScript

Principe
Schéma de production de la documentation

IDE
IDE

IDE
Conventions pour QtCreator
Devant les fonctions ajouter le commentaire ///
///
QString mmd2md::title(int chapter, QString t)
{
return (QString("%1. %1\n").arg(chapter).arg(t));
}
Après avoir entré un retour ligne on obtient automatiquement le squelette qu’il

faut compléter
///
/// \brief mmd2md::title
/// \param chapter
/// \param t
/// \return
///
QString mmd2md::title(int chapter, QString t)
{
return (QString("%1. %1\n").arg(chapter).arg(t));
}
IDE
Doxygen pour Eclipse
Doxygen et Graphviz sont inclus dans le plugin Eclox

Conventions

Rubriques
Premières conventions
Autres commandes


Les commentaires
On peut utiliser plusieurs styles de commentaires

Les commentaires à la javadoc
/**
* ... text ...
*/
Les commentaires à la Qt
/*!
* ... text ...
*/
Les commentaires à la C++
///
/// ... text ...
///

Le caractères < dans les commentaires
Quand on met un commentaire à côté d’un texte et non en dessus ou en dessous il

faut utiliser le caractère d’attention < en plus de l’un des trois commentaires
précédents
int var; //< Detailed description after the member //
Avec les mots clés [in], [out], [in,out] on informe pour les fonctions du type de
paramètre
void foo(int v /**< [in] docs for input parameter v. */);
Ceci ne peut être utilisé que pour documenter les membres et les paramètres.

Rubrique brief
La rubrique brief marque le début d’un paragraphe comprenant une description
/*!
* \brief Pretty nice class.
* \details This class is used to demonstrate a number of section commands.
* \author John Doe
* \author Jan Doe
* \version 4.1a
* \date 1990-2011
* \pre First initialize the system.
* \bug Not all memory is freed when deleting an object of this class.
* \warning Improper use can crash your application
* \copyright GNU Public License.
*/

Autres commandes
Autres commandes

Autres commandes
Liste des commandes
La liste des commandes est disponible et détaillée dans la page

http://www.stack.nl/~dimitri/doxygen/manual/commands.html
Les principales commandes à connaître sont celles résumées dans l’exemple
précédent à savoir :
details : affiche le texte d’une section
author : un ou plusieurs auteurs
version : version dans laquelle le symbole est apparu
date : date à laquelle le symbole est apparu
bug : bug connu
warning : message d’attention
copyright : mention de copyright
Ces commandes peuvent êtres précédées d’un antislash ou d’un @ au choix.

Autres commandes
Inclusion d’autres langages
Des balises HTML peuvent être inclus dans des commentaires Doxygen. Ces
commenaires HTML seront valables aussi bien dans la documentation HTML
générée que la documentation LaTex
Le formatage MarkDown est lui aussi supporté dans les mêmes conditions.

Autres commandes
Utilisation de graphiz
La libraire graphiz permet de générer les diagram (représentés dans la section

Diagrams) à savoir :
les diagrammes de classes
les hiérarchies de classes
les dépendances de classes

DoxyWizard

Rubriques
Lancement

Lancement
Lancement

Lancement
Méthode avec interface graphique

Lancement
Lancement par commande
Une fois Doxywizard lancé ne pas oublier de sauvegarder le fichier via le menu
File/save ( par exemple dans doxyfile.conf)
Ensuite on peut relancer en repassant par doxywizard ou en ligne de commande par
:
doxygen doxyfile.conf

Doxygen

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Doxygen

Transféré par

Droits d'auteur :

Formats disponibles

Présentation Conventions DoxyWizard

Gilles Maire Doxygen 1 / 26

Gilles Maire Doxygen 2 / 26

Gilles Maire Doxygen 3 / 26

Gilles Maire Doxygen 4 / 26

Gilles Maire Doxygen 5 / 26

La documentation de programmes C ou C++ se fait à l’aide du formateur

Gilles Maire Doxygen 6 / 26

Sous Debian/Ubuntu installer :

apt-get install doxygen doxygen-doc doxygen-gui doxygen-dox graphviz

Sous base redhat

dnf install doxygen doxygen-doc doxygen-gui doxygen-dox graphviz

On peut vouloir installer doxygen-latex si on souhaitre produire la documentation

Gilles Maire Doxygen 7 / 26

Schéma de production de la documentation

Gilles Maire Doxygen 8 / 26

Gilles Maire Doxygen 9 / 26

Conventions pour QtCreator

Devant les fonctions ajouter le commentaire ///

Après avoir entré un retour ligne on obtient automatiquement le squelette qu’il

Doxygen pour Eclipse

Doxygen et Graphviz sont inclus dans le plugin Eclox

Gilles Maire Doxygen 11 / 26

Gilles Maire Doxygen 12 / 26

Gilles Maire Doxygen 13 / 26

Gilles Maire Doxygen 14 / 26

On peut utiliser plusieurs styles de commentaires

Les commentaires à la C++

Gilles Maire Doxygen 15 / 26

Le caractères < dans les commentaires

Quand on met un commentaire à côté d’un texte et non en dessus ou en dessous il

int var; //< Detailed description after the member //

void foo(int v /**< [in] docs for input parameter v. */);

Gilles Maire Doxygen 16 / 26

La rubrique brief marque le début d’un paragraphe comprenant une description

Gilles Maire Doxygen 17 / 26

Gilles Maire Doxygen 18 / 26

Liste des commandes

La liste des commandes est disponible et détaillée dans la page

Gilles Maire Doxygen 19 / 26

Inclusion d’autres langages

Gilles Maire Doxygen 20 / 26

La libraire graphiz permet de générer les diagram (représentés dans la section

Gilles Maire Doxygen 21 / 26

Gilles Maire Doxygen 22 / 26

Gilles Maire Doxygen 23 / 26

Gilles Maire Doxygen 24 / 26

Méthode avec interface graphique

Gilles Maire Doxygen 25 / 26

Lancement par commande

Gilles Maire Doxygen 26 / 26

Vous aimerez peut-être aussi