Utilisation de Doxygen

---

Doxygen est un utilitaire basé sur la ligne de commande. Appeler doxygen avec l'option --help sur la ligne de commande vous donnera une brève description de l'utilisation du programme.

Toutes les options se composent d'un caractère de début -, suivi d'un caractère et d'un ou plusieurs arguments selon l'option.

Pour générer un manuel pour votre projet, vous devez généralement suivre ces étapes :

1 . Vous documentez votre code source avec des blocs de documentation spéciaux (voir la section Blocs de commentaires spéciaux).

2 . Vous générez un fichier de configuration (voir la section Configuration) en appelant Doxygen avec l'option -g :

doxygen -g <config_file>

3 . Vous modifiez le fichier de configuration pour qu'il corresponde à votre projet. Dans le fichier de configuration, vous pouvez spécifier les fichiers d'entrée et de nombreuses informations facultatives.

4 . Vous laissez Doxygen générer la documentation, en fonction des paramètres du fichier de configuration :

doxygen <config_file>

Si vous avez un fichier de configuration généré avec une ancienne version de Doxygen, vous pouvez le mettre à niveau vers la version actuelle en exécutant Doxygen avec l'option -u.

doxygen -u <config_file>

Tous les paramètres de configuration du fichier de configuration d'origine seront copiés dans le nouveau fichier de configuration. Toutes les nouvelles options auront leur valeur par défaut. Notez que les commentaires que vous avez éventuellement ajoutés dans le fichier de configuration d'origine seront perdus.

Ajustement précis de la sortie

Si vous souhaitez affiner l'apparence de la sortie, Doxygen vous permet de générer des fichiers de feuille de style, d'en-tête et de pied de page par défaut que vous pouvez modifier par la suite :

• Pour la sortie HTML, vous pouvez générer le fichier d'en-tête par défaut (voir HTML_HEADER), le pied de page par défaut (voir HTML_FOOTER) et la feuille de style par défaut (voir HTML_STYLESHEET), à l'aide de la commande suivante :

doxygen -w html header.html footer.html stylesheet.css <config_file>

Le config_file est facultatif. S'il est omis, Doxygen recherchera un fichier nommé Doxyfile et le traitera. S'il n'est pas trouvé non plus, il utilisera les paramètres par défaut.

• Pour la sortie , vous pouvez générer la première et la dernière partie de refman.tex (voir LATEX_HEADER et LATEX_FOOTER) et la feuille de style incluse par cet en-tête (normalement doxygen.sty), en utilisant la commande suivante :

doxygen -w latex header.tex footer.tex doxygen.sty <config_file>

Si vous avez besoin d'options non par défaut (par exemple pour utiliser des packages supplémentaires), vous devez créer un fichier de configuration avec ces options correctement définies, puis spécifier ce fichier de configuration après les fichiers générés (faites d'abord une sauvegarde du fichier de configuration afin de ne pas le perdre au cas où vous oublieriez de spécifier l'un des fichiers de sortie).

• Pour la sortie RTF, vous pouvez générer le fichier de feuille de style par défaut (voir RTF_STYLESHEET_FILE) en utilisant :

doxygen -w rtf rtfstyle.cfg