Doxygen/fr

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.

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 special commands sont lues 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.

First style: Pythonic documentation
In the following example one docstring is at the beginning to explain the general contents of this module (file). Then docstrings appear inside the function, class, and class method definitions. In this way, Doxygen will extract the comments and present them as is, without modification.

Second style: documentation block before the code
In the following example the documentation blocks start with double hash signs. One appears at the beginning to explain the general content of this module (file). Then there are blocks before the function, class, and class method definitions, and there is one block after a class variable. In this way, Doxygen will extract the documentation, recognize the special commands, , and , and format the text accordingly.

Compiling the documentation
Compilation of documentation proceeds the same as for C++ sources. If both Python files, and, with distinct commenting style are in the same directory, both will be processed.

The documentation should show similar information to the following, and create appropriate links to the individual modules and classes.

Converting the Pythonic style to Doxygen style
In the previous example, the Python file that is commented in a Doxygen style shows more detailed information and formatting for its classes, functions, and variables. The reason is that this style allows Doxygen to extract the special commands that start with or, while the Pythonic style does not. Therefore, it would be desirable to convert the Pythonic style to Doxygen style before compiling the documentation. This is possible with an auxiliary Python program called doxypypy. This program is inspired by an older program called doxypy, which would take the Pythonic  and convert them to the Doxygen comment blocks that start with a double hash. Doxypypy goes further than this, as it analyzes the docstrings and extracts items of interest like variables and arguments, and even doctests (example code in the docstrings).

Doxypypy can be installed using, the Python package installer.

If the command is used without the  option, it will require superuser (root) privileges to install the package, but this is not needed in most cases; use root permissions only if you are certain the package won't collide with your distribution provided packages.

If the package was installed as a user, it may reside in your home directory, for example, in. If this directory is not in your system's, the program will not be found. Therefore, add the directory to the variable, either in your  file, or in your  file.

Alternatively, you can create a symbolic link to the program, placing the link in a directory that is already included in the.

Once the program is installed, and accessible from the terminal, a Python file with Pythonic docstrings can be reformatted to Doxygen style with the following instructions. The program outputs the reformatted code to standard output, so redirect this output to a new file.

The original file has a comment at the top  that indicates the module or namespace that is being described by the file. This keyword is not interpreted when using triple quotes in the comment block.

In the new file the commenting style is changed so the line becomes, which now will be interpreted by Doxygen. However, to be interpreted correctly, the argument has to be edited manually to match the new module (file) name; after doing this the line should be.

(the top is manually edited, the rest stays the same)

To compile, create the configuration, and run in the toplevel directory that contains the files.

The documentation should show similar information to the following, and create appropriate links to the individual modules.

Converting the comment style on the fly
In the previous example, the conversion of the documentation blocks was done manually with only one source file. Ideally we want this conversion to occur automatically, on the fly, with any number of Python files. To do this, the Doxygen configuration must be edited accordingly.

To start, don't use the program directly; instead, create the configuration file with, then edit the created , and modify the following tag.

What this does is that files that match the pattern, all files with a extension ending in, will go through the program. Every time Doxygen encounters such file in the source tree, the file name will be passed as the first argument to this program.

The program does not exist by default; it should be created as a shell script to run  with the appropriate options, and to take a file as its first argument.

After saving this shell script, make sure it has execute permissions, and that it is located in a directory contained in your system's.

On Windows systems, a batch file can be used in a similar way.

With this configuration done, the command can be run to generate the documentation as usual. Every Python file using Pythonic  will be reformatted on the fly to use  style comments, and then will be processed by Doxygen, which now will be able to interpret the special commands and Mardown syntax. The original source code won't be modified, and no temporary file with a different name needs to be created as in the previous section; therefore, if a instruction is found, it doesn't need to be changed manually.

Note that existing Python files which already use the style for their comment blocks won't be affected by the  filter, and will be processed by Doxygen normally.



Python code quality check
To use the automatic conversion of documentation blocks it is important that the original Python sources are correctly written, following the Pythonic guidelines in PEP8 and PEP257. Sloppily written code will cause to fail when processing the file, and thus Doxygen will be unable to format the documentation correctly.

The following commenting styles will not allow parsing of the docstrings by, so they should be avoided.

Always use triple quotes for the docstrings, and make sure they immediately follow the class or function declaration.

It is also a good idea to verify the quality of your Python code with a tool such as flake8 (Gitlab). Flake8 primarily combines three tools, Pyflakes, Pycodestyle (formerly pep8), and the McCabe complexity checker, in order to enforce proper Pythonic style.

To check all files inside a source tree use.

If the project demands it, some code checks deemed too strict can be ignored. The error codes can be consulted in the Pycodestyle documentation.

In similar way, a program that primarily checks that comments comply with PEP257 is Pydocstyle. The error codes can be consulted in the Pydocstyle documentation.

Also use it with to perform docstring checks on all source files.

Source documentation with Sphinx
Sphinx is the most popular system to document Python source code. However, since FreeCAD's core functions and workbenches are written in C++ it was deemed that Doxygen is a better documentation tool for this project.

While Sphinx can natively parse Python docstrings, it requires a bit more work to parse C++ sources. The Breathe (Github) project is an attempt at bridging the gap between Sphinx and Doxygen, in order to integrate both Python and C++ source code documentation in the same system. First, Doxygen needs to be configured to output an XML file; the XML output is then read by Breathe, and converted to suitable input for Sphinx.

See the Quick start guide in the Breathe documentation to know more about this process.

See this answer in Stackoverflow for other alternatives to documenting C++ and Python code together in the same project.