Doxygen/fr

About
Doxygen est un outil populaire pour générer de la documentation à partir de sources C ++ annotées. Il prend également en charge d'autres langages de programmation populaires tels que C#, PHP, Java et Python. Visitez le site Web Doxygen pour en savoir plus sur le système et consultez le Manuel Doxygen pour plus d'informations.

Doxygen and FreeCAD
Ce document fournit une brève introduction à Doxygen, en particulier comment il est utilisé dans FreeCAD pour documenter ses sources. Consultez la page Documentation du code source pour obtenir des instructions sur la construction de la documentation FreeCAD, également hébergée en ligne sur le site Web FreeCAD API.



Doxygen avec du code C++
La section Mise en route (étape 3) du manuel Doxygen mentionne les méthodes de base pour documenter les sources.

Pour les membres, les classes et les espaces de noms, deux options sont disponibles:
 * 1) Placez un "bloc de documentation" spécial (un paragraphe commenté) avant la déclaration ou la définition de la fonction, du membre, de la classe ou de l'espace de noms. Pour les fichiers, classes et membres espaces de nom (variables), il est également autorisé de placer la documentation directement après le membre. Voir la section Blocs de commentaires spéciaux dans le manuel pour en savoir plus sur ces blocs.
 * 2) Placez un bloc de documentation spécial ailleurs (un autre fichier ou un autre emplacement dans le même fichier) et insérez une "commande structurelle" dans le bloc de documentation. Une commande structurelle lie un bloc de documentation à une certaine entité pouvant être documentée (une fonction, un membre, une variable, une classe, un espace de noms ou un fichier). Voir la section Documentation à d'autres endroits dans le manuel pour en savoir plus sur les commandes structurelles.

Remarque:
 * L'avantage de la première option est qu'il n'est pas nécessaire de répéter le nom de l'entité (fonction, membre, variable, classe ou espace de nom) car Doxygen analysera le code et extraira les informations pertinentes.
 * Les fichiers ne peuvent être documentés qu'en utilisant la deuxième option car il n'y a aucun moyen de mettre un bloc de documentation avant un fichier. Bien sûr, les membres de fichiers (fonctions, variables, typedefs, définit) n'ont pas besoin d'une commande structurelle explicite. il suffit de mettre un bloc de documentation avant ou après eux fonctionnera très bien.

Premier style: bloc de documentation avant le code
Généralement, vous souhaiterez documenter le code dans le fichier d'en-tête, juste avant la déclaration de classe ou le prototype de fonction. Ceci permet de garder la déclaration et la documentation proches les unes des autres, il est donc facile de mettre à jour la dernière si le premier change.

Le bloc spécial de documentation commence comme un commentaire de type C mais comporte un astérisque supplémentaire soit. Le bloc se termine par un correspondant. Une alternative consiste à utiliser des commentaires de style C ++ avec une barre oblique supplémentaire soit.

Deuxième style: bloc de documentation ailleurs
Sinon, la documentation peut être placée dans un autre fichier (ou dans le même fichier en haut ou en bas, ou ailleurs) à l'écart de la déclaration de classe ou du prototype de fonction. Dans ce cas, vous aurez des informations dupliquées, une fois dans le fichier source réel et une fois dans le fichier de documentation.

Premier fichier, :

Deuxième fichier, :

Dans ce cas, la commande structurelle est utilisée pour indiquer le fichier source documenté. Une commande structurelle indique que le code suivant est une fonction et que la commande  est utilisée pour décrire brièvement cette fonction.

Cette façon de documenter un fichier source est utile si vous souhaitez simplement ajouter de la documentation à votre projet sans ajouter de code réel. Lorsque vous placez un bloc de commentaires dans un fichier portant l’une des extensions suivantes, , ou alors Doxygen analysera les commentaires et construira la documentation appropriée mais masquera ce fichier auxiliaire de la liste des fichiers.

Le projet FreeCAD ajoute plusieurs fichiers se terminant par dans de nombreux répertoires afin de fournir une description ou des exemples du code correspondant. Il est important que ces fichiers soient correctement classés dans un groupe ou un espace de noms pour lequel Doxygen fournit des commandes auxiliaires telles que, et.

Exemple. Ce fichier dans l'arborescence des sources de FreeCAD donne une brève explication de l'espace de noms.

Un autre exemple est le fichier. Avant les détails d'implémentation des méthodes, il existe un bloc de documentation qui explique certains détails de la structure de commande de FreeCAD. Il comporte diverses commandes pour structurer la documentation. Il comprend même un exemple de code inclus dans une paire de mots-clés et. Lorsque le fichier est traité par Doxygen, cet exemple de code sera spécialement formaté pour se démarquer. Le mot clé est utilisé à plusieurs endroits pour créer des liens vers des sections, sous-sections, pages ou ancres nommées dans la documentation. De même, les commandes ou  affichent le libellé "See also" et fournissent un lien vers d'autres classes, fonctions, méthodes, variables, fichiers ou URL. Exemple

Exemple du projet VTK
Ceci est un exemple tiré de VTK, une bibliothèque de visualisation 3D utilisée pour présenter des données scientifiques, telles que des résultats d'éléments finis et des informations de nuage de points.

Une classe pour stocker une collection de coordonnées est définie dans un fichier d'en-tête C++. La partie supérieure du fichier est commentée et quelques mots-clés sont utilisés, tels que, et  pour indiquer les parties importantes. Dans la classe, avant les prototypes de méthode de classe, un bloc de texte commenté explique le rôle de la fonction et ses arguments.
 * Code source de vtkArrayCoordinates.h.
 * Doxygen a produit de la documentation pour la classe vtkArrayCoordinates.

Compiler la documentation


Pour générer la documentation du code source, il existe deux étapes de base:
 * 1) Créez un fichier de configuration pour contrôler la façon dont Doxygen traitera les fichiers source.
 * 2) Exécutez  sur cette configuration.

Le processus est décrit ci-dessous.


 * Assurez-vous que les programmes et  sont installés sur votre système. Il est également recommandé de disposer du programme  de Graphviz afin de générer des diagrammes avec les relations entre les classes et les espaces de noms. Sur les systèmes Linux, ces programmes peuvent être installés à partir de votre gestionnaire de paquets.

Assurez-vous d'être dans le même dossier que vos fichiers sources ou dans le répertoire toplevel de votre arborescence des sources si vous avez plusieurs fichiers sources dans différents sous-répertoires.


 * Exécutez pour créer un fichier de configuration nommé . Si vous omettez ce nom, la valeur par défaut sera  sans extension.
 * Il s’agit d’un gros fichier texte contenant de nombreuses variables avec leurs valeurs. Dans le manuel Doxygen, ces variables sont appelées "tags". Le fichier de configuration et toutes les balises sont décrits en détail dans la section Configuration du manuel. Vous pouvez ouvrir le fichier avec n’importe quel éditeur de texte et éditer la valeur de chaque balise selon vos besoins. Dans le même fichier, vous pouvez lire des commentaires expliquant chacune des balises et leurs valeurs par défaut.


 * Au lieu d'utiliser un éditeur de texte, vous pouvez lancer pour modifier plusieurs tags en même temps. Avec cette interface, vous pouvez définir de nombreuses propriétés telles que les informations de projet, le type de sortie (HTML et LaTeX), l’utilisation de Graphviz pour créer des diagrammes, les messages d’avertissement à afficher, les modèles de fichiers (extensions) à documenter ou à exclure, les filtres de saisie, les en-têtes facultatifs. et des bas de page pour les pages générées HTML, des options pour les sorties LaTeX, RTF, XML ou Docbook, et de nombreuses autres options.


 * Une autre option consiste à créer le fichier de configuration à partir de rien et à ajouter uniquement les balises souhaitées avec un éditeur de texte.
 * Une fois la configuration enregistrée, vous pouvez exécuter Doxygen sur ce fichier de configuration.


 * La documentation générée sera créée dans un dossier nommé . Il se composera de nombreuses pages HTML, d’images PNG pour les graphiques, de feuilles de style en cascade, de fichiers Javascript et éventuellement de nombreux sous-répertoires contenant plus de fichiers, selon la taille de votre code. Le point d’entrée dans la documentation est  que vous pouvez ouvrir avec un navigateur Web.

Si vous écrivez de nouvelles classes, fonctions ou un tout nouveau atelier, il est recommandé d'exécuter périodiquement pour vérifier que la documentation bloque, Markdown et commandes spéciales sont lus correctement et toutes les fonctions publiques sont entièrement documentées. Veuillez également lire les conseils de documentation situés dans le code source.

Lorsque vous générez la documentation complète de FreeCAD, vous n’exécutez pas directement. Au lieu de cela, le projet utilise pour configurer l'environnement de construction, puis  déclenche la compilation des sources FreeCAD et de la documentation Doxygen; ceci est expliqué dans la page Documentation du code source.

Balisage Doxygen
Toutes les commandes Doxygen documentation des commandes commencent par une barre oblique inversée ou un symbole at, selon vos préférences. Normalement, la barre oblique inversée est utilisée mais il arrive que  soit utilisée pour améliorer la lisibilité.

Les commandes peuvent avoir un ou plusieurs arguments. Dans le manuel Doxygen, les arguments sont décrits comme suit.
 * Si des accolades sont utilisées, l'argument est un mot unique.
 * Si vous utilisez des accolades, l'argument s'étend jusqu'à la fin de la ligne sur laquelle la commande a été trouvée.
 * Si des accolades   sont utilisées, l'argument s'étend jusqu'au paragraphe suivant. Les paragraphes sont délimités par une ligne vide ou par un indicateur de section.
 * Si des crochets sont utilisés, l'argument est facultatif.

Certains des mots-clés les plus couramment utilisés dans la documentation FreeCAD sont présentés ici.
 * , voir \defgroup, et Grouping.
 * , voir \ingroup, et Grouping.
 * , voir \addtogroup, et Grouping.
 * , voir \author; indique l'auteur de ce morceau de code.
 * , voir \brief; décrit brièvement la fonction.
 * , voir \file; documente un fichier source ou en-tête.
 * , voir \page; place les informations dans une page distincte, sans lien direct avec une classe, un fichier ou un membre spécifique.
 * , voir \package; indique la documentation d'un package Java (mais également utilisée avec Python).
 * , voir \fn; documente une fonction.
 * , voir \var; documente une variable; il est équivalent à, et.
 * , see \section; commence une section.
 * , voir \subsection; commence une sous-section.
 * , voir \namespace; indique des informations pour un espace de noms.
 * , and, voir \cond; définit un bloc à documenter ou à omettre conditionnellement.
 * , voir \a; affiche l'argument en italique pour mettre l'accent.
 * , voir \param; indique le paramètre d'une fonction.
 * , voir \return; spécifie la valeur de retour.
 * , voir \sa; écrit "See also".
 * , voir \note; ajoute un paragraphe à utiliser comme note.

Support de Markdown
Depuis Doxygen 1.8, la syntaxe de Markdown est reconnue dans les blocs de documentation. Markdown est un langage de formatage minimaliste inspiré du courrier électronique en texte brut qui, semblable à la syntaxe wiki, se veut simple et lisible sans nécessiter un code compliqué comme celui que l'on trouve dans les commandes HTML, LaTeX ou Doxygen. Markdown a gagné en popularité avec les logiciels libres, en particulier sur les plates-formes en ligne telles que Github, car il permet de créer de la documentation sans utiliser de code compliqué. Consultez la section Markdown support du manuel Doxygen pour en savoir plus. Visitez le site Web de Markdown pour en savoir plus sur l'origine et la philosophie de Markdown.

Doxygen prend en charge un ensemble standard d'instructions de Markdown, ainsi que certaines extensions telles que Github Markdown. Quelques exemples de formatage Markdown sont présentés ci-après.

Ce qui suit est standard Markdown. {{Code|code= Voici le texte pour un paragraphe.

Nous continuons avec plus de texte dans un autre paragraphe.

Ceci est un en-tête de niveau 1

=
===========

Ceci est un en-tête de niveau 2


 * 1) Ceci est un en-tête de niveau 1


 * 1) Ceci est un en-tête de niveau 3 #######

> Il s'agit d'une citation en bloc > s'étendant sur plusieurs lignes

- Item 1

Plus de texte pour cet item.

- Item 2 * élément de liste imbriqué. * un autre élément imbriqué. - Item 3

1. Premier item. 2. Deuxième item.


 * astérisques simples: accentuation*

_underscores simples_

**double astérisque: forte accentuation**

__underscores doubles__

Ceci est un paragraphe normal

Ceci est un bloc de code

Nous continuons avec un paragraphe normal à nouveau.

Utilisation de la fonction `printf`. En ligne `code`.

[Le lien texte](http://example.net/)

![Texte de légende](/path/to/img.jpg)

 }}

Ce qui suit sont des extensions de Markdown. [TOC]

Premier en-tête | Deuxième en-tête - | - Cellule de contenu | Cellule de contenu Cellule de contenu | Cellule de contenu

~ {.py} class Dummy: pass ~
 * 1) A class

~ {.c} int func(int a, int b) { return a*b; } ~

``` int func(int a, int b) { return a*b; } ```

Analyse des blocs de documentation
Le texte contenu dans un bloc de documentation spécial est analysé avant d’être écrit dans les fichiers de sortie HTML et LaTeX. Pendant l'analyse, les étapes suivantes ont lieu:
 * Le formatage de Markdown est remplacé par l'HTML correspondant ou des commandes spéciales.
 * Les commandes spéciales à l'intérieur de la documentation sont exécutées. Voir la section Special Commands dans le manuel pour une explication de chaque commande.
 * Si une ligne commence par un espace suivi d'un ou de plusieurs astérisques puis éventuellement plus d'espaces, tous les espaces et astérisques sont supprimés.
 * Toutes les lignes vierges résultantes sont traitées comme des séparateurs de paragraphe.
 * Des liens sont automatiquement créés pour les mots correspondant aux classes ou fonctions documentées. Si le mot est précédé d'un symbole de pourcentage, ce symbole est supprimé et aucun lien n'est créé pour le mot.
 * Les liens sont créés lorsque certains motifs se trouvent dans le texte. Voir la section Automatic link generation dans le manuel pour plus d'informations.
 * Les balises HTML figurant dans la documentation sont interprétées et converties en équivalents LaTeX pour la sortie LaTeX. Voir la section HTML Commands du manuel pour une explication de chaque balise HTML prise en charge.

Doxygen avec du code Python
Doxygen fonctionne mieux pour les langages de type statique tel que le C++. Cependant, il peut également créer une documentation for Python files.

Il existe deux manières d'écrire des blocs de documentation pour Python:
 * 1) A la Python, en utilisant "docstrings", c’est-à-dire un bloc de texte entouré de   immédiatement après la définition de la classe ou de la fonction.
 * 2) La manière Doxygen, en mettant les commentaires avant la définition de la classe ou de la fonction; dans ce cas, les caractères de double hachage  sont utilisés pour démarrer le bloc de documentation, puis un seul caractère de hachage peut être utilisé dans les lignes suivantes.

Remarque:
 * La première option est préférable pour se conformer à PEP8, PEP257 et la plupart des directives de style pour l'écriture de Python (voir 1, 2). Il est recommandé d'utiliser ce style si vous souhaitez produire des sources documentées à l'aide de Sphinx qui est un outil très courant pour documenter le code Python. Si vous utilisez ce style, Doxygen pourra extraire les commentaires textuellement mais les commandes spéciales Doxygen commençant par ou  ne fonctionneront pas.
 * La deuxième option n'est pas dans le style Python traditionnel mais vous permet d'utiliser les commandes spéciales de Doxygen telles que et.

Premier style: documentation de Python
Dans l'exemple suivant, une docstring est au début pour expliquer le contenu général de ce module (fichier). Ensuite, les docstrings apparaissent dans les définitions de méthode, de classe et de méthode. De cette façon, Doxygen extraira les commentaires et les présentera tels quels, sans modification.

Deuxième style: bloc de documentation avant le code
Dans l'exemple suivant, les blocs de documentation commencent par un double signe de hachage. On apparaît au début pour expliquer le contenu général de ce module (fichier). Ensuite, il y a des blocs avant les définitions de méthode, de classe et de méthode de classe, et un bloc après une variable de classe. De cette manière, Doxygen extraira la documentation, reconnaîtra les commandes spéciales, et  et formatera le texte en conséquence.

Compiler la documentation
La compilation de la documentation se déroule de la même manière que pour des sources C++. Si les deux fichiers Python, et, avec un style de commentaire distinct se trouvent dans le même répertoire, ils seront tous deux traités.

La documentation doit afficher des informations similaires à celles qui suivent et créer des liens appropriés vers les modules et les classes individuels.

Convertir du style à la Python en style à la Doxygen
Dans l'exemple précédent, le fichier Python commenté dans un style à la Doxygen affiche des informations plus détaillées et un formatage pour ses classes, fonctions et variables. La raison en est que ce style permet à Doxygen d'extraire les commandes spéciales commençant par ou, contrairement au style à la Python. Par conséquent, il serait souhaitable de convertir le style Pythonic en style Doxygen avant de compiler la documentation. Ceci est possible avec un programme auxiliaire Python appelé doxypypy. Ce programme est inspiré d’un programme plus ancien appelé doxypy, qui prendrait le  de Pythonic et les convertir en blocs de commentaires Doxygen commençant par un double hachage. Doxypypy va plus loin que cela en analysant les docstrings et en extrayant des éléments d’intérêt tels que des variables et des arguments, voire des doctests (exemple de code dans les docstrings).

Doxypypy peut être installé en utilisant, le programme d'installation du paquet Python.

Si la commande est utilisée sans l'option, des privilèges de super-utilisateur (root) seront nécessaires pour installer le package, mais ce n'est pas nécessaire dans la plupart des cas. Utilisez les autorisations root uniquement si vous êtes certain que le package ne se trouvera pas en conflit avec les packages fournis par votre distribution.

Si le package a été installé en tant qu'utilisateur, il peut résider dans votre répertoire personnel, par exemple dans. Si ce répertoire ne se trouve pas dans de votre système, le programme ne sera pas trouvé. Par conséquent, ajoutez le répertoire à la variable, soit dans votre fichier , soit dans votre fichier.

Vous pouvez également créer un lien symbolique vers le programme en le plaçant dans un répertoire déjà inclus dans.

Une fois que le programme est installé et accessible depuis le terminal, un fichier Python contenant des docstrings Pythonic peut être reformaté en style Doxygen avec les instructions suivantes. Le programme sort le code reformaté sur la sortie standard, redirige donc cette sortie vers un nouveau fichier.

Le fichier d'origine contient un commentaire en haut  qui indique le module ou l'espace de noms décrit par le fichier. Ce mot clé n'est pas interprété lors de l'utilisation de guillemets triples dans le bloc de commentaires.

Dans le nouveau fichier, le style de commentaire est modifié pour que la ligne devienne qui sera à présent interprétée par Doxygen. Cependant, pour être interprété correctement, l'argument doit être modifié manuellement pour correspondre au nouveau nom du module (fichier). Après cela, la ligne doit être.

(le haut est édité manuellement, le reste reste le même)

Pour compiler, créez la configuration et exécutez dans le répertoire de niveau supérieur contenant les fichiers.

La documentation doit afficher des informations similaires à celles qui suivent et créer des liens appropriés vers les modules et les classes individuels.

Convertir le style commentaire à la volée
Dans l'exemple précédent, la conversion des blocs de documentation a été effectuée manuellement avec un seul fichier source. Idéalement, nous souhaitons que cette conversion se fasse automatiquement, à la volée, avec un nombre quelconque de fichiers Python. Pour ce faire, la configuration Doxygen doit être modifiée en conséquence.

Pour commencer, n’utilisez pas directement le programme. Créez à la place le fichier de configuration avec puis éditez le  créé et modifiez la balise suivante.

Cela signifie que les fichiers correspondant au modèle, tous les fichiers dont l'extension se termine par, passent par le programme. Chaque fois que Doxygen rencontre un tel fichier dans l'arborescence source, le nom du fichier est transmis en tant que premier argument à ce programme.

Le programme n'existe pas par défaut. Il doit être créé en tant que script shell pour exécuter avec les options appropriées et pour prendre un fichier comme premier argument.

Après avoir enregistré ce script shell, assurez-vous qu'il dispose des autorisations nécessaires et qu'il se trouve dans un répertoire contenu dans votre de votre système.

Sur les systèmes Windows, un fichier batch peut être utilisé de la même manière.

Une fois cette configuration effectuée, vous pouvez exécuter la commande pour générer la documentation normalement. Tous les fichiers Python utilisant triple quotes </code Pythonic seront reformatés à la volée pour utiliser des commentaires de style puis être traité par Doxygen, qui sera désormais en mesure d'interpréter les commandes speciales  et la syntaxe de Mardown. Le code source d'origine ne sera pas modifié et aucun fichier temporaire portant un nom différent ne doit être créé, comme dans le paragraphe précédent. Par conséquent, si une instruction est trouvée, elle n'a pas besoin d'être modifiée manuellement.

Notez que les fichiers Python existants qui utilisent déjà le style pour leurs blocs de commentaires ne seront pas affectés par le filtre  et seront traités normalement par Doxygen.



Contrôle de la qualité du code Python
Pour utiliser la conversion automatique des blocs de documentation, il est important que les sources Python d'origine soient correctement écrites conformément aux instructions de Python présentées dans PEP8 et PEP257. Un code mal écrit provoquera l’échec de lors du traitement du fichier, empêchant ainsi Doxygen de formater correctement la documentation.

Les styles de commentaire suivants ne permettent pas l'analyse des docstrings par. Ils doivent donc être évités.

Utilisez toujours des guillemets triples pour les docstrings et assurez-vous qu'ils suivent immédiatement la déclaration de la classe ou de la fonction.

C'est également une bonne idée de vérifier la qualité de votre code Python avec un outil tel que flake8 (Gitlab). Flake8 combine principalement trois outils, Pyflakes, Pycodestyle (anciennement pep8) et le McCabe complexity checker (Vérificateur de complexité McCabe) afin d'appliquer le style Pythonic approprié.

Pour vérifier tous les fichiers dans une arborescence source, utilisez.

Si le projet l'exige, certaines vérifications de code jugées trop strictes peuvent être ignorées. Les codes d'erreur peuvent être consultés dans la documentation Pycodestyle.

De la même façon, un programme qui vérifie principalement que les commentaires sont conformes à PEP257 est Pydocstyle. Les codes d'erreur peuvent être consultés dans la documentation Pydocstyle.

Utilisez-le également avec pour effectuer des vérifications de docstring sur tous les fichiers source.

Documentation source avec Sphinx
Sphinx est le système le plus populaire pour documenter le code source Python. Cependant, étant donné que les fonctions principales et les ateliers de FreeCAD sont écrits en C++, il a été jugé que Doxygen est un meilleur outil de documentation pour ce projet.

Bien que Sphinx puisse analyser nativement les docstrings Python, cela demande un peu plus de travail d'analyser les sources C++. Le projet Breathe (Github) est une tentative de combler le fossé entre Sphinx et Doxygen, afin de Intégrez la documentation de code source Python et C++ dans le même système. Premièrement, Doxygen doit être configuré pour générer un fichier XML. la sortie XML est alors lue par Breathe et convertie en entrée appropriée pour Sphinx.

Consultez le Guide de démarrage rapide dans la documentation de Breathe pour en savoir plus sur ce processus.

Voir cette réponse dans Stackoverflow pour d'autres alternatives permettant de documenter le code C++ et Python ensemble dans le même projet.

Related

 * Source Documentation
 * FreeCAD API website