Ce site est en cours de reconstruction certains liens peuvent ne pas fonctionner ou certaines images peuvent ne pas s'afficher.

stacks

1. Introduction au C++

1.12. Documentation

Doxygen, contraction de documents (docs = dox) generator, est un générateur de documentation capable de produire une documentation logicielle à partir du code source d'un programme en se basant sur la syntaxe du langage dans lequel est écrit le code source.

L'utilisation de balises de commentaires permet de donner un format ergonomique et agréable à la documentation finale qui est générée sous forme de site web. On peut également générer la documentation en LaTeX, Postscript ou PDF.

1.12.1. Génération et customisation du fichier de configuration

doxygen -g
# or
doxygen -g <config-file>

modifier ensuite les variables du fichier :

PROJECT_NAME           = "My Project"
PROJECT_NUMBER         = 1.0
INPUT                  = src
OUTPUT_DIRECTORY       = doc

1.12.2. Documenter le code

Voir la documentation relative au code

Exemple Xerces C