Configuration

Format

Un fichier de configuration est un fichier texte ASCII de forme libre avec une structure similaire à celle d'un Makefile, avec le nom par défaut Doxyfile. Il est analysé par doxygen. Le fichier peut contenir des tabulations et des sauts de ligne à des fins de formatage. Les instructions du fichier sont sensibles à la casse.

Le fichier de configuration se compose essentiellement d'une liste d'instructions d'affectation. Chaque instruction se compose d'un TAG_NAME écrit en majuscules, suivi du signe égal (=) et d'une ou plusieurs valeurs. Si la même balise est affectée plusieurs fois, la dernière affectation remplace toute affectation précédente. Pour les balises qui prennent une liste comme argument, l'opérateur += peut être utilisé à la place de = pour ajouter de nouvelles valeurs à la liste. Les valeurs sont des séquences de caractères non vides. Si la valeur doit contenir un ou plusieurs caractères vides, elle doit être entourée de guillemets ("..."). Plusieurs lignes peuvent être concaténées en insérant une barre oblique inverse (\) comme dernier caractère non vide d'une ligne.

Les commentaires commencent par le caractère dièse (#) et se terminent à la fin de la ligne. Les commentaires peuvent être placés n'importe où dans le fichier (sauf entre guillemets). Les commentaires commençant par deux caractères dièse (##) sont conservés lors de la mise à jour du fichier de configuration lorsqu'ils sont placés devant un TAG_NAME, ou au début ou à la fin du fichier de configuration.

Les variables d'environnement peuvent être étendues à l'aide du modèle $(ENV_VARIABLE_NAME). Un petit exemple :

DOT_PATH = $(YOUR_DOT_PATH)

Vous pouvez également inclure une partie d'un fichier de configuration à partir d'un autre fichier de configuration à l'aide d'une balise @INCLUDE comme suit :

@INCLUDE = config_file_name

Le fichier d'inclusion est recherché dans le répertoire de travail actuel. Vous pouvez également spécifier une liste de répertoires dans lesquels la recherche doit être effectuée avant de rechercher dans le répertoire de travail actuel. Pour ce faire, placez une balise @INCLUDE_PATH avec ces chemins avant la balise @INCLUDE, par exemple :

@INCLUDE_PATH = my_config_dir

Les options de configuration peuvent être divisées en plusieurs catégories. Vous trouverez ci-dessous un index alphabétique des balises reconnues, suivi des descriptions des balises regroupées par catégorie.

Options de configuration liées au projet

DOXYFILE_ENCODING

Cette balise spécifie l'encodage utilisé pour tous les caractères du fichier de configuration qui suivent. La valeur par défaut est UTF-8, qui est également l'encodage utilisé pour tout le texte avant la première occurrence de cette balise. Doxygen utilise libiconv (ou l'iconv intégré à la libc) pour le transcodage. Voir "https://www.gnu.org/software/libiconv/pour la liste des encodages possibles.

La valeur par défaut est : UTF-8.

PROJECT_NAME

La balise PROJECT_NAME est un mot unique (ou une séquence de mots entourés de guillemets, sauf si vous utilisez Doxywizard) qui doit identifier le projet pour lequel la documentation est générée. Ce nom est utilisé dans le titre de la plupart des pages générées et à quelques autres endroits.

La valeur par défaut est : My Prroject.

PROJECT_NUMBER

La balise PROJECT_NUMBER peut être utilisée pour saisir un numéro de projet ou de révision. Cela peut être utile pour archiver la documentation générée ou si un système de contrôle de version est utilisé.

PROJECT_BRIEF

En utilisant la balise PROJECT_BRIEF, on peut fournir une description facultative d'une ligne pour un projet qui apparaît en haut de chaque page et devrait donner aux lecteurs une idée rapide de l'objectif du projet. Gardez la description courte.

PROJECT_LOGO

Avec la balise PROJECT_LOGO, on peut spécifier un logo ou une icône qui est inclus dans la documentation. La hauteur maximale du logo ne doit pas dépasser 55 pixels et la largeur maximale ne doit pas dépasser 200 pixels. Doxygen copiera le logo dans le répertoire de sortie.

PROJECT_ICON

Avec la balise PROJECT_ICON, on peut spécifier une icône qui est incluse dans les onglets lorsque le document HTML est affiché. Doxygen copiera le logo dans le répertoire de sortie.

OUTPUT_DIRECTORY

La balise OUTPUT_DIRECTORY permet de spécifier le chemin (relatif ou absolu) dans lequel la documentation générée sera écrite. Si un chemin relatif est saisi, il sera relatif à l'emplacement où Doxygen a été démarré. Si vous laissez ce champ vide, le répertoire actuel sera utilisé.

CREATE_SUBDIRS

Si la balise CREATE_SUBDIRS est définie sur YES, Doxygen créera jusqu'à 4096 sous-répertoires (sur 2 niveaux) sous le répertoire de sortie de chaque format de sortie et distribuera les fichiers générés sur ces répertoires. L'activation de cette option peut être utile lorsque vous alimentez Doxygen avec une quantité énorme de fichiers sources, où placer tous les fichiers générés dans le même répertoire entraînerait sinon des problèmes de performances pour le système de fichiers. Adaptez CREATE_SUBDIRS_LEVEL pour contrôler le nombre de sous-répertoires.

La valeur par défaut est : NO.

CREATE_SUBDIRS_LEVEL

Contrôle le nombre de sous-répertoires qui seront créés lorsque la balise CREATE_SUBDIRS est définie sur YES. Le niveau 0 représente 16 répertoires, et chaque incrément de niveau double le nombre de répertoires, ce qui donne 4096 répertoires au niveau 8, qui est la valeur par défaut et également la valeur maximale. Les sous-répertoires sont organisés en 2 niveaux, le premier niveau a toujours un nombre fixe de 16 répertoires.

Valeur minimale : 0, valeur maximale : 8, valeur par défaut : 8.

Cette balise nécessite que la balise CREATE_SUBDIRS soit définie sur YES.

ALLOW_UNICODE_NAMES

Si la balise ALLOW_UNICODE_NAMES est définie sur YES, Doxygen autorisera l'apparition de caractères non ASCII dans les noms des fichiers générés. Si elle est définie sur NO, les caractères non ASCII seront échappés, par exemple _xE3_x81_x84 sera utilisé pour Unicode U+3044.

La valeur par défaut est : NO.

OUTPUT_LANGUAGE

La balise OUTPUT_LANGUAGE permet de spécifier la langue dans laquelle toute la documentation générée par Doxygen est écrite. Doxygen utilisera ces informations pour générer toutes les sorties constantes dans la langue appropriée.

Les valeurs possibles sont : Afrikaans, Arabe, Arménien, Brésilien, Bulgare, Catalan, Chinois, Chinois-Traditionnel, Croate, Tchèque, Danois, Néerlandais, Anglais (États-Unis), Espéranto, Farsi (Persan), Finnois, Français, Allemand, Grec, Hindi, Hongrois, Indonésien, Italien, Japonais, Japonais-en (Japonais avec Messages en Anglais), Coréen, Coréen-en (Coréen avec Messages en Anglais), Letton, Lituanien, Macédonien, Norvégien, Persan (Farsi), Polonais, Portugais, Roumain, Russe, Serbe, Serbe-Cyrillique, Slovaque, Slovène, Espagnol, Suédois, Turc, Ukrainien et Vietnamien.

La valeur par défaut est : English.

BRIEF_MEMBER_DESC

Si la balise BRIEF_MEMBER_DESC est définie sur YES, Doxygen inclura de brèves descriptions de membres après les membres répertoriés dans la documentation du fichier et de la classe (similaire à Javadoc). Définissez sur NO pour désactiver cette option.

La valeur par défaut est : YES.

REPEAT_BRIEF

Si la balise REPEAT_BRIEF est définie sur YES, Doxygen ajoutera la brève description d'un membre ou d'une fonction avant la description détaillée. Remarque : si HIDE_UNDOC_MEMBERS et BRIEF_MEMBER_DESC sont tous deux définis sur NO, les brèves descriptions seront complètement supprimées.

La valeur par défaut est : YES.

ABBREVIATE_BRIEF

Cette balise implémente un abréviateur de description brève quasi-intelligent qui est utilisé pour former le texte dans diverses listes. Chaque chaîne de cette liste, si elle est trouvée comme texte principal de la description brève, sera supprimée du texte et le résultat, après traitement de la liste entière, sera utilisé comme texte annoté. Sinon, la description brève est utilisée telle quelle. Si elle est laissée vide, les valeurs suivantes sont utilisées ($name est automatiquement remplacé par le nom de l'entité) : la class $name, le widget $name, le file $name, is, provides, specifies, contains, represents, a, an et the.

ALWAYS_DETAILED_SEC

Si les balises ALWAYS_DETAILED_SEC et REPEAT_BRIEF sont toutes deux définies sur YES, Doxygen générera une section détaillée même s'il n'y a qu'une brève description.

La valeur par défaut est : NO.

INLINE_INHERITED_MEMB

Si la balise INLINE_INHERITED_MEMB est définie sur YES, Doxygen affichera tous les membres hérités d'une classe dans la documentation de cette classe comme si ces membres étaient des membres de classe ordinaires. Les constructeurs, destructeurs et opérateurs d'affectation des classes de base ne seront pas affichés.

La valeur par défaut est : NO.

FULL_PATH_NAMES

Si la balise FULL_PATH_NAMES est définie sur YES, Doxygen ajoutera le chemin complet avant le nom des fichiers dans la liste des fichiers et dans les fichiers d'en-tête. Si elle est définie sur NO, le chemin le plus court qui rend le nom de fichier unique sera utilisé.

La valeur par défaut est : YES.

STRIP_FROM_PATH

La balise STRIP_FROM_PATH peut être utilisée pour supprimer une partie définie par l'utilisateur du chemin. La suppression n'est effectuée que si l'une des chaînes spécifiées correspond à la partie gauche du chemin. La balise peut être utilisée pour afficher les chemins relatifs dans la liste des fichiers. Si ce champ est laissé vide, le répertoire à partir duquel Doxygen est exécuté est utilisé comme chemin d'accès à supprimer. Notez que vous pouvez spécifier ici des chemins absolus, mais aussi des chemins relatifs, qui seront relatifs à partir du répertoire où Doxygen est démarré.

Cette balise nécessite que la balise FULL_PATH_NAMES soit définie sur YES.

STRIP_FROM_INC_PATH

La balise STRIP_FROM_INC_PATH peut être utilisée pour supprimer une partie définie par l'utilisateur du chemin mentionné dans la documentation d'une classe, qui indique au lecteur quel fichier d'en-tête inclure pour utiliser une classe. Si ce champ est laissé vide, seul le nom du fichier d'en-tête contenant la définition de classe est utilisé. Sinon, il faut spécifier la liste des chemins d'inclusion qui sont normalement passés au compilateur à l'aide de l'indicateur -I.

SHORT_NAMES

Si la balise SHORT_NAMES est définie sur YES, Doxygen générera des noms de fichiers beaucoup plus courts (mais moins lisibles). Cela peut être utile si votre système de fichiers ne prend pas en charge les noms longs comme sur DOS, Mac ou CD-ROM.

La valeur par défaut est : NO.

JAVADOC_AUTOBRIEF

Si la balise JAVADOC_AUTOBRIEF est définie sur YES, Doxygen interprétera la première ligne (jusqu'au premier point, point d'interrogation ou point d'exclamation) d'un commentaire de style Javadoc comme une brève description. Si elle est définie sur NO, le style Javadoc se comportera comme des commentaires de style Qt classiques (nécessitant ainsi une commande @brief explicite pour une brève description).

La valeur par défaut est : NO.

JAVADOC_BANNER

Si la balise JAVADOC_BANNER est définie sur YES, Doxygen interprétera une ligne telle que

/***************

comme étant le début d'une « bannière » de commentaire de style Javadoc. Si elle est définie sur NO, le style Javadoc se comportera comme des commentaires classiques et ne sera pas interprété par Doxygen.

La valeur par défaut est : NO.

QT_AUTOBRIEF

Si la balise QT_AUTOBRIEF est définie sur YES, Doxygen interprétera la première ligne (jusqu'au premier point, point d'interrogation ou point d'exclamation) d'un commentaire de style Qt comme une brève description. Si elle est définie sur NO, le style Qt se comportera comme des commentaires de style Qt normaux (nécessitant ainsi une commande \brief explicite pour une brève description).

La valeur par défaut est : NO.

MULTILINE_CPP_IS_BRIEF

La balise MULTILINE_CPP_IS_BRIEF peut être définie sur YES pour que Doxygen traite un bloc de commentaires spéciaux C++ multiligne (c'est-à-dire un bloc de commentaires //! ou ///) comme une brève description. C'était le comportement par défaut. Le nouveau comportement par défaut consiste à traiter un bloc de commentaires C++ multiligne comme une description détaillée. Définissez cette balise sur YES si vous préférez l'ancien comportement. Notez que définir cette balise sur YES signifie également que les commentaires rationnels de type rose ne sont plus reconnus.

La valeur par défaut est : NO.

PYTHON_DOCSTRING

Par défaut, les docstrings Python sont affichés sous forme de texte préformaté et les commandes spéciales de Doxygen ne peuvent pas être utilisées. En définissant PYTHON_DOCSTRING sur NO, les commandes spéciales de Doxygen peuvent être utilisées et le contenu des blocs de documentation de docstring est affiché sous forme de documentation Doxygen.

La valeur par défaut est : YES.

INHERIT_DOCS

Si la balise INHERIT_DOCS est définie sur YES, un membre non documenté hérite de la documentation de tout membre documenté qu'il réimplémente.

La valeur par défaut est : YES.

SEPARATE_MEMBER_PAGES

Si la balise SEPARATE_MEMBER_PAGES est définie sur YES, Doxygen produira une nouvelle page pour chaque membre. Si elle est définie sur NO, la documentation d'un membre fera partie du fichier/de la classe/de l'espace de noms qui le contient.

La valeur par défaut est : NO.

TAB_SIZE

La balise TAB_SIZE peut être utilisée pour définir le nombre d'espaces dans une tabulation. Doxygen utilise cette valeur pour remplacer les tabulations par des espaces dans les fragments de code.

Valeur minimale : 1, valeur maximale : 16, valeur par défaut : 4.

ALIASES

Cette balise peut être utilisée pour spécifier un nombre d'alias qui agissent comme des commandes dans la documentation. Un alias a la forme :

nom=valeur

Par exemple, ajouter

"sideeffect=@par Effets secondaires :^^"

vous permettra de placer la commande \sideeffect (ou @sideeffect) dans la documentation, ce qui donnera lieu à un paragraphe défini par l'utilisateur avec le titre « Effets secondaires : ». Notez que vous ne pouvez pas placer de \n dans la partie valeur d'un alias pour insérer des sauts de ligne (dans la sortie résultante). Vous pouvez placer ^^ dans la partie valeur d'un alias pour insérer un saut de ligne comme si un saut de ligne physique se trouvait dans le fichier d'origine. Lorsque vous avez besoin d'un littéral{ ou } ou , dans la partie valeur d'un alias, vous devez les échapper au moyen d'une barre oblique inverse (\), cela peut entraîner des conflits avec les commandes \{ et \} pour celles-ci, il est conseillé d'utiliser la version @{ et @} ou d'utiliser un double échappement (\\{ et \\})

OPTIMIZE_OUTPUT_FOR_C

Définissez la balise OPTIMIZE_OUTPUT_FOR_C sur YES si votre projet se compose uniquement de sources C. Doxygen générera alors une sortie plus adaptée au C. Par exemple, certains des noms utilisés seront différents. La liste de tous les membres sera omise, etc.

La valeur par défaut est : NO.

OPTIMIZE_OUTPUT_JAVA

Définissez la balise OPTIMIZE_OUTPUT_JAVA sur YES si votre projet se compose uniquement de sources Java ou Python. Doxygen générera alors une sortie plus adaptée à ce langage. Par exemple, les espaces de noms seront présentés sous forme de packages, les portées qualifiées auront un aspect différent, etc.

La valeur par défaut est : NO.

OPTIMIZE_FOR_FORTRAN

Définissez la balise OPTIMIZE_FOR_FORTRAN sur YES si votre projet se compose de sources Fortran. Doxygen générera alors une sortie adaptée au Fortran.

La valeur par défaut est : NO.

OPTIMIZE_OUTPUT_VHDL

Définissez la balise OPTIMIZE_OUTPUT_VHDL sur YES si votre projet se compose de sources VHDL. Doxygen générera alors une sortie adaptée au VHDL.

La valeur par défaut est : NO.

OPTIMIZE_OUTPUT_SLICE

Définissez la balise OPTIMIZE_OUTPUT_SLICE sur YES si votre projet se compose uniquement de sources Slice. Doxygen générera alors une sortie plus adaptée à ce langage. Par exemple, les espaces de noms seront présentés sous forme de modules, les types seront séparés en plusieurs groupes, etc.

La valeur par défaut est : NO.

EXTENSION_MAPPING

Doxygen sélectionne l'analyseur à utiliser en fonction de l'extension des fichiers qu'il analyse. Avec cette balise, vous pouvez attribuer l'analyseur à utiliser pour une extension donnée. Doxygen dispose d'un mappage intégré, mais vous pouvez le remplacer ou l'étendre à l'aide de cette balise. Le format est ext=language, où ext est une extension de fichier et language est l'un des analyseurs pris en charge par Doxygen : IDL, Java, JavaScript, Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, Fortran (format fixe Fortran : FortranFixed, format libre Fortran : FortranFree, format inconnu Fortran : Fortran. Dans ce dernier cas, l'analyseur essaie de deviner si le code est au format fixe ou libre, c'est la valeur par défaut pour les fichiers de type Fortran).

Par exemple, pour que Doxygen traite les fichiers .inc comme des fichiers Fortran (la valeur par défaut est PHP) et les fichiers .f comme des fichiers C (la valeur par défaut est Fortran), utilisez : inc=Fortran f=C.

Remarque : pour les fichiers sans extension, vous pouvez utiliser no_extension comme espace réservé. Notez que pour les extensions personnalisées, vous devez également définir FILE_PATTERNS, sinon les fichiers ne sont pas lus par Doxygen. Lorsque vous spécifiez no_extension, vous devez ajouter * à FILE_PATTERNS. Remarque : consultez également la liste des mappages d'extensions de fichiers par défaut.

MARKDOWN_SUPPORT

Si la balise MARKDOWN_SUPPORT est activée, Doxygen prétraite tous les commentaires selon le format Markdown, ce qui permet une documentation plus lisible. Voir https://daringfireball.net/projects/markdown/ pour plus de détails. La sortie du traitement Markdown est ensuite géré par Doxygen, vous pouvez donc mélanger les commandes Doxygen, HTML et XML avec le formatage Markdown. Désactivez-la uniquement en cas de problèmes de compatibilité ascendante.

La valeur par défaut est : YES.

TOC_INCLUDE_HEADINGS

Lorsque la balise TOC_INCLUDE_HEADINGS est définie sur une valeur différente de zéro, tous les titres jusqu'à ce niveau sont automatiquement inclus dans la table des matières, même s'ils n'ont pas d'attribut id.

Note
Cette fonctionnalité s'applique actuellement uniquement aux titres Markdown.

Valeur minimale : 0, valeur maximale : 99, valeur par défaut : 6.

Cette balise nécessite que la balise MARKDOWN_SUPPORT soit définie sur YES.

MARKDOWN_ID_STYLE

La balise MARKDOWN_ID_STYLE peut être utilisée pour spécifier l'algorithme utilisé pour générer des identifiants pour les titres Markdown. Remarque : chaque identifiant est unique.

Les valeurs possibles sont : DOXYGEN utilise une chaîne fixe « autotoc_md » suivie d'un numéro de séquence commençant à 0 et GITHUB utilise la version minuscule du titre avec tout espace blanc remplacé par « - » et les caractères de ponctuation supprimés.

La valeur par défaut est : DOXYGEN.

Cette balise nécessite que la balise MARKDOWN_SUPPORT soit définie sur YES.

AUTOLINK_SUPPORT

Lorsqu'elle est activée, Doxygen essaie de lier les mots qui correspondent aux classes documentées ou aux espaces de noms à leur documentation correspondante. Un tel lien peut être empêché dans des cas individuels en plaçant un signe % devant le mot ou globalement en définissant AUTOLINK_SUPPORT sur NO. Les mots répertoriés dans la balise AUTOLINK_IGNORE_WORDS sont exclus de la liaison automatique.

La valeur par défaut est : YES.

AUTOLINK_IGNORE_WORDS

Cette balise spécifie une liste de mots qui, lorsqu'ils correspondent au début d'un mot dans la documentation, supprimeront la génération automatique de liens, si elle est activée via AUTOLINK_SUPPORT. Cette liste n'affecte pas les liens créés explicitement à l'aide de # ou des commandes \link ou \ref.

Cette balise nécessite que la balise AUTOLINK_SUPPORT soit définie sur YES.

BUILTIN_STL_SUPPORT

Si vous utilisez des classes STL (par exemple std::string, std::vector, etc.) mais que vous ne souhaitez pas inclure (un fichier de balises pour) les sources STL en entrée, vous devez définir cette balise sur YES afin de permettre à Doxygen de faire correspondre les déclarations et définitions de fonctions dont les arguments contiennent des classes STL (par exemple, func(std::string); par rapport à func(std::string) {}. Cela rend également les diagrammes d'héritage et de collaboration qui impliquent des classes STL plus complets et plus précis.

La valeur par défaut est : NO.

CPP_CLI_SUPPORT

Si vous utilisez le langage C++/CLI de Microsoft, vous devez définir cette option sur YES pour activer la prise en charge de l'analyse.

La valeur par défaut est : NO.

SIP_SUPPORT

Définissez la balise SIP_SUPPORT sur YES si votre projet se compose uniquement de sources sip SIP. Doxygen les analysera comme du C++ normal mais supposera que toutes les classes utilisent l'héritage public au lieu de l'héritage privé lorsqu'aucun mot-clé de protection explicite n'est présent.

La valeur par défaut est : NO.

IDL_PROPERTY_SUPPORT

Pour l'IDL de Microsoft, il existe des attributs propget et propput pour indiquer les méthodes getter et setter pour une propriété. La définition de cette option sur YES obligera Doxygen à remplacer les méthodes get et set par une propriété dans la documentation. Cela ne fonctionnera que si les méthodes obtiennent ou définissent effectivement un type simple. Si ce n'est pas le cas, ou si vous souhaitez quand même afficher les méthodes, vous devez définir cette option sur NO.

La valeur par défaut est : YES.

DISTRIBUTE_GROUP_DOC

Si le regroupement de membres est utilisé dans la documentation et que la balise DISTRIBUTE_GROUP_DOC est définie sur YES, Doxygen réutilisera la documentation du premier membre du groupe (le cas échéant) pour les autres membres du groupe. Par défaut, tous les membres d'un groupe doivent être documentés explicitement.

La valeur par défaut est : NO.

GROUP_NESTED_COMPOUNDS

Si l'on ajoute une structure ou une classe à un groupe et que cette option est activée, alors toute classe ou structure imbriquée est également ajoutée au même groupe. Par défaut, cette option est désactivée et il faut ajouter explicitement des composés imbriqués via \ingroup.

La valeur par défaut est : NO.

SUBGROUPING

Définissez la balise SUBGROUPING sur YES pour permettre aux groupes de membres de classe du même type (par exemple un groupe de fonctions publiques) d'être placés comme sous-groupe de ce type (par exemple sous la section Fonctions publiques). Définissez-la sur NO pour empêcher le sous-groupement. Alternativement, cela peut être fait par classe en utilisant la commande \nosubgrouping.

La valeur par défaut est : YES.

INLINE_GROUPED_CLASSES

Lorsque la balise INLINE_GROUPED_CLASSES est définie sur YES, les classes, les structures et les unions sont affichées à l'intérieur du groupe dans lequel elles sont incluses (par exemple en utilisant \ingroup) au lieu d'une page séparée (pour les pages HTML et Man) ou d'une section (pour latex et RTF). Notez que cette fonctionnalité ne fonctionne pas en combinaison avec SEPARATE_MEMBER_PAGES.

La valeur par défaut est : NO.

INLINE_SIMPLE_STRUCTS

Lorsque la balise INLINE_SIMPLE_STRUCTS est définie sur YES, les structures, les classes et les unions avec uniquement des champs de données publics ou des champs de typedef simples seront affichées en ligne dans la documentation de la portée dans laquelle elles sont définies (c'est-à-dire la documentation du fichier, de l'espace de noms ou du groupe), à ​​condition que cette portée soit documentée. Si la valeur est NO, les structures, les classes et les unions sont affichées sur une page distincte (pour les pages HTML et Man) ou une section (pour latex et RTF).

La valeur par défaut est : NO.

TYPEDEF_HIDES_STRUCT

Lorsque la balise TYPEDEF_HIDES_STRUCT est activée, un typedef d'une structure, d'une union ou d'une énumération est documenté comme structure, union ou énumération avec le nom du typedef. Ainsi, typedef struct TypeS {} TypeT, apparaîtra dans la documentation comme une structure avec le nom TypeT. Lorsqu'il est désactivé, le typedef apparaîtra comme un membre d'un fichier, d'un espace de noms ou d'une classe. Et la structure sera nommée TypeS. Cela peut généralement être utile pour le code C dans le cas où la convention de codage impose que tous les types composés soient typés et que seul le typedef soit référencé, jamais le nom de la balise.

La valeur par défaut est : NO.

LOOKUP_CACHE_SIZE

La taille du cache de recherche de symboles peut être définie à l'aide de LOOKUP_CACHE_SIZE. Ce cache est utilisé pour résoudre les symboles en fonction de leur nom et de leur portée. Comme cela peut être un processus coûteux et que le même symbole apparaît souvent plusieurs fois dans le code, Doxygen conserve un cache de symboles pré-résolus. Si le cache est trop petit, Doxygen devient plus lent. Si le cache est trop grand, la mémoire est gaspillée. La taille du cache est donnée par cette formule :
cache1.
La plage valide est 0..9, la valeur par défaut est 0, correspondant à une taille de cache de :
cache2 symboles.
À la fin d'une exécution, Doxygen signalera l'utilisation du cache et suggérera la taille de cache optimale du point de vue de la vitesse.

Valeur minimale : 0, valeur maximale : 9, valeur par défaut : 0.

NUM_PROC_THREADS

Le NUM_PROC_THREADS spécifie le nombre de threfads que Doxygen est autorisé à utiliser pendant le traitement. Lorsqu'il est défini sur 0, Doxygen se basera sur le nombre de cœurs disponibles dans le système. Vous pouvez le définir explicitement sur une valeur supérieure à 0 pour obtenir un meilleur contrôle sur l'équilibre entre la charge du processeur et la vitesse de traitement. Pour le moment, seul le traitement des entrées peut être effectué à l'aide de plusieurs threfads. Comme il s'agit encore d'une fonctionnalité expérimentale, la valeur par défaut est définie sur 1, ce qui désactive effectivement le traitement parallèle. Veuillez signaler tout problème que vous rencontrez. La génération de graphiques à points en parallèle est contrôlée par le paramètre DOT_NUM_THREADS.

Valeur minimale : 0, valeur maximale : 32, valeur par défaut : 1.

TIMESTAMP

Si la balise TIMESTAMP est définie différemment de NO, chaque page générée contiendra la date ou la date et l'heure de génération de la page. La définition de cette valeur sur NO peut aider à comparer la sortie de plusieurs exécutions.

Les valeurs possibles sont : YES, NO, DATETIME et DATE.

La valeur par défaut est : NO.

Options de configuration liées à la construction

EXTRACT_ALL

Si la balise EXTRACT_ALL est définie sur YES, Doxygen supposera que toutes les entités de la documentation sont documentées, même si aucune documentation n'était disponible. Les membres de classe privés et les membres de fichier statiques seront masqués à moins que les balises EXTRACT_PRIVATE et EXTRACT_STATIC ne soient définies sur YES.

Note
Cela désactivera également les avertissements concernant les membres non documentés qui sont normalement générés lorsque les WARNINGS sont définis sur YES.

La valeur par défaut est : NO.

EXTRACT_PRIVATE

Si la balise EXTRACT_PRIVATE est définie sur YES, tous les membres privés d'une classe seront inclus dans la documentation.

La valeur par défaut est : NO.

EXTRACT_PRIV_VIRTUAL

Si la balise EXTRACT_PRIV_VIRTUAL est définie sur YES, les méthodes virtuelles privées documentées d'une classe seront incluses dans la documentation.

La valeur par défaut est : NO.

EXTRACT_PACKAGE

Si la balise EXTRACT_PACKAGE est définie sur YES, tous les membres avec une portée de package ou interne seront inclus dans la documentation.

La valeur par défaut est : NO.

EXTRACT_STATIC

Si la balise EXTRACT_STATIC est définie sur YES, tous les membres statiques d'un fichier seront inclus dans la documentation.

La valeur par défaut est : NO.

EXTRACT_LOCAL_CLASSES

Si la balise EXTRACT_LOCAL_CLASSES est définie sur YES, les classes (et structures) définies localement dans les fichiers sources seront incluses dans la documentation. Si elle est définie sur NO, seules les classes définies dans les fichiers d'en-tête sont incluses. N'a aucun effet pour les sources Java.

La valeur par défaut est : YES.

EXTRACT_LOCAL_METHODS

Cet indicateur n'est utile que pour le code Objective-C. S'il est défini sur YES, les méthodes locales, qui sont définies dans la section d'implémentation mais pas dans l'interface, sont incluses dans la documentation. S'il est défini sur NO, seules les méthodes de l'interface sont incluses.

La valeur par défaut est : NO.

EXTRACT_ANON_NSPACES

Si cet indicateur est défini sur YES, les membres des espaces de noms anonymes seront extraits et apparaîtront dans la documentation sous la forme d'un espace de noms appelé 'anonymous_namespace{file}', où fichier sera remplacé par le nom de base du fichier qui contient l'espace de noms anonyme. Par défaut, les espaces de noms anonymes sont masqués.

La valeur par défaut est : NO.

RESOLVE_UNNAMED_PARAMS

Si cet indicateur est défini sur YES, le nom d'un paramètre sans nom dans une déclaration sera déterminé par la définition correspondante. Par défaut, les paramètres sans nom restent sans nom dans la sortie.

La valeur par défaut est : YES.

HIDE_UNDOC_MEMBERS

Si la balise HIDE_UNDOC_MEMBERS est définie sur YES, Doxygen masquera tous les membres non documentés à l'intérieur des classes ou fichiers documentés. Si elle est définie sur NO, ces membres seront inclus dans les différentes vues d'ensemble, mais aucune section de documentation n'est générée. Cette option n'a aucun effet si EXTRACT_ALL est activé.

La valeur par défaut est : NO.

HIDE_UNDOC_CLASSES

Si la balise HIDE_UNDOC_CLASSES est définie sur YES, Doxygen masquera toutes les classes non documentées qui sont normalement visibles dans la hiérarchie des classes. Si elle est définie sur NO, ces classes seront incluses dans les différentes vues d'ensemble. Cette option masquera également les concepts C++ non documentés si elle est activée. Cette option n'a aucun effet si EXTRACT_ALL est activé.

La valeur par défaut est : NO.

HIDE_UNDOC_NAMESPACES

Si la balise HIDE_UNDOC_NAMESPACES est définie sur YES, Doxygen masquera tous les espaces de noms non documentés qui sont normalement visibles dans la hiérarchie des espaces de noms. Si elle est définie sur NO, ces espaces de noms seront inclus dans les différentes vues d'ensemble. Cette option n'a aucun effet si EXTRACT_ALL est activé.

La valeur par défaut est : YES.

HIDE_FRIEND_COMPOUNDS

Si la balise HIDE_FRIEND_COMPOUNDS est définie sur YES, Doxygen masquera toutes les déclarations d'amis. Si elle est définie sur NO, ces déclarations seront incluses dans la documentation.

La valeur par défaut est : NO.

HIDE_IN_BODY_DOCS

Si la balise HIDE_IN_BODY_DOCS est définie sur YES, Doxygen masquera tous les blocs de documentation trouvés dans le corps d'une fonction. Si la valeur est définie sur NO, ces blocs seront ajoutés au bloc de documentation détaillée de la fonction.

La valeur par défaut est : NO.

INTERNAL_DOCS

La balise INTERNAL_DOCS détermine si la documentation saisie après une commande \internal est incluse. Si la balise est définie sur NO, la documentation sera exclue. Définissez-la sur YES pour inclure la documentation interne.

La valeur par défaut est : NO.

CASE_SENSE_NAMES

Avec le réglage correct de l'option CASE_SENSE_NAMES, Doxygen sera mieux en mesure de correspondre aux capacités du système de fichiers sous-jacent.

Si le système de fichiers est sensible à la casse (c'est-à-dire qu'il prend en charge les fichiers du même répertoire dont les noms ne diffèrent que par la casse), l'option doit être définie sur YES pour traiter correctement ces fichiers au cas où ils apparaîtraient dans l'entrée.

Pour les systèmes de fichiers qui ne sont pas sensibles à la casse, l'option doit être définie sur NO pour gérer correctement les fichiers de sortie écrits pour des symboles qui ne diffèrent que par la casse, comme pour deux classes, l'une nommée CLASS et l'autre nommée Class, et pour également prendre en charge les références aux fichiers sans avoir à spécifier la casse correspondante exacte.

Sous Windows (y compris Cygwin) et macOS, les utilisateurs doivent généralement définir cette option sur NO, tandis que sous Linux ou d'autres versions d'Unix, elle doit généralement être définie sur YES.

Les valeurs possibles sont : SYSTEM, NO et YES.

La valeur par défaut est : SYSTEM.

HIDE_SCOPE_NAMES

Si la balise HIDE_SCOPE_NAMES est définie sur NO, Doxygen affichera les membres avec leurs portées complètes de classe et d'espace de noms dans la documentation. Si elle est définie sur YES, la portée sera masquée.

La valeur par défaut est : NO.

HIDE_COMPOUND_REFERENCE

Si la balise HIDE_COMPOUND_REFERENCE est définie sur NO (par défaut), Doxygen ajoutera du texte supplémentaire au titre d'une page, comme Référence de classe. Si elle est définie sur YES, la référence composée sera masquée.

La valeur par défaut est : NO.

SHOW_HEADERFILE

Si la balise SHOW_HEADERFILE est définie sur YES, la documentation d'une classe indiquera quel fichier doit être inclus pour utiliser la classe.

La valeur par défaut est : YES.

SHOW_INCLUDE_FILES

Si la balise SHOW_INCLUDE_FILES est définie sur YES, Doxygen placera une liste des fichiers inclus par un fichier dans la documentation de ce fichier.

La valeur par défaut est : YES.

SHOW_GROUPED_MEMB_INC

Si la balise SHOW_GROUPED_MEMB_INC est définie sur YES, Doxygen ajoutera pour chaque membre groupé une instruction d'inclusion à la documentation, indiquant au lecteur quel fichier inclure pour utiliser le membre.

La valeur par défaut est : NO.

FORCE_LOCAL_INCLUDES

Si la balise FORCE_LOCAL_INCLUDES est définie sur YES, Doxygen répertorie les fichiers d'inclusion avec des guillemets doubles dans la documentation plutôt qu'avec des crochets pointus.

La valeur par défaut est : NO.

INLINE_INFO

Si la balise INLINE_INFO est définie sur YES, une balise [inline] est insérée dans la documentation pour les membres en ligne.

La valeur par défaut est : YES.

SORT_MEMBER_DOCS

Si la balise SORT_MEMBER_DOCS est définie sur YES, Doxygen trie la documentation (détaillée) des membres de fichier et de classe par ordre alphabétique de nom de membre. Si elle est définie sur NO, les membres apparaîtront dans l'ordre de déclaration.

La valeur par défaut est : YES.

SORT_BRIEF_DOCS

Si la balise SORT_BRIEF_DOCS est définie sur YES, Doxygen trie les brèves descriptions des membres de fichier, d'espace de noms et de classe par ordre alphabétique de nom de membre. Si la valeur est définie sur NO, les membres apparaîtront dans l'ordre de déclaration. Notez que cela influencera également l'ordre des classes dans la liste des classes.

La valeur par défaut est : NO.

SORT_MEMBERS_CTORS_1ST

Si la balise SORT_MEMBERS_CTORS_1ST est définie sur YES, Doxygen triera la documentation (brève et détaillée) des membres de classe afin que les constructeurs et les destructeurs soient répertoriés en premier. Si la valeur est définie sur NO, les constructeurs apparaîtront dans les ordres respectifs définis par SORT_BRIEF_DOCS et SORT_MEMBER_DOCS.

Note
Si SORT_BRIEF_DOCS est défini sur NO, cette option est ignorée pour le tri de la documentation brève des membres.
Si SORT_MEMBER_DOCS est défini sur NO, cette option est ignorée pour le tri de la documentation détaillée des membres.

La valeur par défaut est : NO.

SORT_GROUP_NAMES

Si la balise SORT_GROUP_NAMES est définie sur YES, Doxygen triera la hiérarchie des noms de groupe par ordre alphabétique. Si elle est définie sur NO, les noms de groupe apparaîtront dans leur ordre défini.

La valeur par défaut est : NO.

SORT_BY_SCOPE_NAME

Si la balise SORT_BY_SCOPE_NAME est définie sur YES, la liste des classes sera triée par noms entièrement qualifiés, y compris les espaces de noms. Si elle est définie sur NO, la liste des classes sera triée uniquement par nom de classe, sans inclure la partie espace de noms.

Note
Cette option n'est pas très utile si HIDE_SCOPE_NAMES est défini sur YES.
Cette option s'applique uniquement à la liste des classes, pas à la liste alphabétique.

La valeur par défaut est : NO.

STRICT_PROTO_MATCHING

Si l'option STRICT_PROTO_MATCHING est activée et que Doxygen ne parvient pas à effectuer une résolution de type appropriée de tous les paramètres d'une fonction, il rejettera une correspondance entre le prototype et l'implémentation d'une fonction membre même s'il n'y a qu'un seul candidat ou s'il est évident de choisir le candidat en effectuant une simple correspondance de chaîne. En désactivant STRICT_PROTO_MATCHING, Doxygen acceptera toujours une correspondance entre le prototype et l'implémentation dans de tels cas.

La valeur par défaut est : NO.

GENERATE_TODOLIST

La balise GENERATE_TODOLIST peut être utilisée pour activer (YES) ou désactiver (NO) la liste des tâches. Cette liste est créée en plaçant les commandes \todo dans la documentation.

La valeur par défaut est : YES.

GENERATE_TESTLIST

La balise GENERATE_TESTLIST peut être utilisée pour activer (YES) ou désactiver (NO) la liste des tests. Cette liste est créée en plaçant les commandes \test dans la documentation.

La valeur par défaut est : YES.

GENERATE_BUGLIST

La balise GENERATE_BUGLIST peut être utilisée pour activer (YES) ou désactiver (NO) la liste des bogues. Cette liste est créée en plaçant les commandes \bug dans la documentation.

La valeur par défaut est : YES.

GENERATE_DEPRECATEDLIST

La balise GENERATE_DEPRECATEDLIST peut être utilisée pour activer (YES) ou désactiver (NO) la liste obsolète. Cette liste est créée en plaçant des commandes \deprecated dans la documentation.

La valeur par défaut est : YES.

ENABLED_SECTIONS

La balise ENABLED_SECTIONS peut être utilisée pour activer les sections de documentation conditionnelles, marquées par les blocs \if <section_label> ... \endif et \cond <section_label> ... \endcond.

MAX_INITIALIZER_LINES

La balise MAX_INITIALIZER_LINES détermine le nombre maximal de lignes que la valeur initiale d'une variable ou d'une macro / définition peut avoir pour qu'elle apparaisse dans la documentation. Si l'initialiseur se compose de plus de lignes que ce qui est spécifié ici, il sera masqué. Utilisez une valeur de 0 pour masquer complètement les initialiseurs. L'apparence de la valeur des variables individuelles et des macros/définitions peut être contrôlée à l'aide de la commande \showinitializer ou \hideinitializer dans la documentation, quel que soit ce paramètre.

Valeur minimale : 0, valeur maximale : 10 000, valeur par défaut : 30.

SHOW_USED_FILES

Définissez la balise SHOW_USED_FILES sur NO pour désactiver la liste des fichiers générés au bas de la documentation des classes et des structures. Si elle est définie sur YES, la liste mentionnera les fichiers qui ont été utilisés pour générer la documentation.

La valeur par défaut est : YES.

SHOW_FILES

Définissez la balise SHOW_FILES sur NO pour désactiver la génération de la page Fichiers. Cela supprimera l'entrée Fichiers de l'index rapide et de l'arborescence des dossiers (si spécifiée).

La valeur par défaut est : YES.

SHOW_NAMESPACES

Définissez la balise SHOW_NAMESPACES sur NO pour désactiver la génération de la page Espaces de noms. Cela supprimera l'entrée Namespaces de l'index rapide et de l'arborescence des dossiers (si spécifiée).

La valeur par défaut est : YES.

FILE_VERSION_FILTER

La balise FILE_VERSION_FILTER peut être utilisée pour spécifier un programme ou un script que Doxygen doit invoquer pour obtenir la version actuelle de chaque fichier (généralement à partir du système de contrôle de version). Doxygen invoquera le programme en exécutant (via popen()) la commande input-file, où command est la valeur de la balise FILE_VERSION_FILTER et input-file est le nom d'un fichier d'entrée fourni par Doxygen. Tout ce que le programme écrit sur la sortie standard est utilisé comme version du fichier.

Exemple d'utilisation d'un script shell comme filtre pour Unix :

FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"</p>

Exemple de script shell pour CVS :

#!/bin/sh
cvs status $1 | sed -n 's/^[ \]*Révision de travail :[ \t]*\‍([0-9][0-9\.]*\‍).*/\1/p'

Exemple de script shell pour Subversion :

#!/bin/sh
svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'

Exemple de filtre pour ClearCase :

FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"

LAYOUT_FILE

La balise LAYOUT_FILE peut être utilisée pour spécifier un fichier de mise en page qui sera analysé par Doxygen. Le fichier de mise en page contrôle la structure globale des fichiers de sortie générés de manière indépendante du format de sortie. Pour créer le fichier de mise en page qui représente les valeurs par défaut de Doxygen, exécutez Doxygen avec l'option -l. Vous pouvez éventuellement spécifier un nom de fichier après l'option, si DoxygenLayout.xml sera utilisé comme nom du fichier de mise en page. Voir également la section Modification de la mise en page pour plus d'informations. Notez que si vous exécutez Doxygen à partir d'un répertoire contenant un fichier appelé DoxygenLayout.xml, Doxygen l'analysera automatiquement même si la balise LAYOUT_FILE est laissée vide.

CITE_BIB_FILES

La balise CITE_BIB_FILES peut être utilisée pour spécifier un ou plusieurs fichiers bib contenant les définitions de référence. Il doit s'agir d'une liste de fichiers .bib. L'extension .bib est automatiquement ajoutée si elle est omise. Cela nécessite l'installation de l'outil bibtex. Voir également https://en.wikipedia.org/wiki/BibTeX pour plus d'informations. Pour latex, le style de la bibliographie peut être contrôlé à l'aide de LATEX_BIB_STYLE. Pour utiliser cette fonctionnalité, vous avez besoin de bibtex et de perl disponibles dans le chemin de recherche. Voir aussi \cite pour plus d'informations sur la création de références.

EXTERNAL_TOOL_PATH

La balise EXTERNAL_TOOL_PATH peut être utilisée pour étendre le chemin de recherche (variable d'environnement PATH) afin que des outils externes tels que latex et gs puissent être trouvés.

Note
Les répertoires spécifiés avec EXTERNAL_TOOL_PATH sont ajoutés devant le chemin déjà spécifié par la variable PATH et sont ajoutés dans l'ordre spécifié.
Cette option est particulièrement utile pour la version 14 de macOS (Sonoma) et supérieure, lors de l'exécution de Doxygen à partir de Doxywizard, car dans ce cas, toutes les modifications définies par l'utilisateur apportées au PATH sont ignorées. Un exemple typique sur macOS consiste à définir : 

EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin
avec le chemin standard, le chemin de recherche complet utilisé par doxygen lors du lancement d'outils externes deviendra alors 
PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin.

Options de configuration liées aux messages d'avertissement et de progression

QUIET

La balise QUIET peut être utilisée pour activer/désactiver les messages générés sur la sortie standard par Doxygen. Si QUIET est défini sur YES, cela implique que les messages sont désactivés.

La valeur par défaut est : NO.

WARNINGS

La balise WARNINGS peut être utilisée pour activer/désactiver les messages d'avertissement générés sur l'erreur standard (stderr) par Doxygen. Si AVERTISSEMENTS est défini sur YES, cela implique que les avertissements sont activés. Astuce : activez les avertissements lors de la rédaction de la documentation.

La valeur par défaut est : YES.

WARN_IF_UNDOCUMENTED

Si la balise WARN_IF_UNDOCUMENTED est définie sur YES, Doxygen génère des avertissements pour les membres non documentés. Si EXTRACT_ALL est défini sur YES, cet indicateur sera automatiquement désactivé.

La valeur par défaut est : YES.

WARN_IF_DOC_ERROR

Si la balise WARN_IF_DOC_ERROR est définie sur YES, Doxygen génère des avertissements pour les erreurs potentielles dans la documentation, telles que la documentation de certains paramètres dans une fonction documentée deux fois, la documentation de paramètres qui n'existent pas ou l'utilisation incorrecte de commandes de balisage.

La valeur par défaut est : YES.

WARN_IF_INCOMPLETE_DOC

Si WARN_IF_INCOMPLETE_DOC est défini sur YES, Doxygen avertit en cas de documentation incomplète des paramètres de fonction. Si elle est définie sur NO, Doxygen acceptera que certains paramètres n'aient pas de documentation sans avertissement.

La valeur par défaut est : YES.

WARN_NO_PARAMDOC

Cette option WARN_NO_PARAMDOC peut être activée pour obtenir des avertissements pour les fonctions qui sont documentées, mais qui n'ont pas de documentation pour leurs paramètres ou leur valeur de retour. Si elle est définie sur NO, Doxygen avertit uniquement en cas de documentation incorrecte des paramètres, mais pas en cas d'absence de documentation. Si EXTRACT_ALL est défini sur YES, cet indicateur sera automatiquement désactivé. Voir aussi WARN_IF_INCOMPLETE_DOC

La valeur par défaut est : NO.

WARN_IF_UNDOC_ENUM_VAL

Si l'option WARN_IF_UNDOC_ENUM_VAL est définie sur YES, Doxygen avertira des valeurs d'énumération non documentées. Si elle est définie sur NO, Doxygen acceptera les valeurs d'énumération non documentées. Si EXTRACT_ALL est défini sur YES, cet indicateur sera automatiquement désactivé.

La valeur par défaut est : NO.

WARN_LAYOUT_FILE

Si l'option WARN_LAYOUT_FILE est définie sur YES, Doxygen avertira des problèmes détectés lors de l'analyse du fichier de mise en page défini par l'utilisateur, tels que des éléments manquants ou incorrects. Voir aussi LAYOUT_FILE pour plus de détails. Si elle est définie sur NO, les problèmes liés au fichier de mise en page seront supprimés.

La valeur par défaut est : YES.

WARN_AS_ERROR

Si la balise WARN_AS_ERROR est définie sur YES, Doxygen s'arrête immédiatement lorsqu'un avertissement est détecté. Si la balise WARN_AS_ERROR est définie sur FAIL_ON_WARNINGS, Doxygen continue de fonctionner comme si la balise WARN_AS_ERROR était définie sur NO, mais à la fin du processus Doxygen, Doxygen renvoie un état différent de zéro. Si la balise WARN_AS_ERROR est définie sur FAIL_ON_WARNINGS_PRINT, Doxygen se comporte comme FAIL_ON_WARNINGS, mais si aucun WARN_LOGFILE n'est défini, Doxygen n'écrira pas les messages d'avertissement entre d'autres messages, mais les écrira à la fin d'une exécution. Si un WARN_LOGFILE est défini, les messages d'avertissement seront non seulement dans le fichier défini, mais également affichés à la fin d'une exécution, à moins que le WARN_LOGFILE ne soit défini comme - c'est-à-dire comme sortie standard (stdout) ; dans ce cas, le comportement restera le même qu'avec le paramètre FAIL_ON_WARNINGS.

Les valeurs possibles sont : NO, YES, FAIL_ON_WARNINGS et FAIL_ON_WARNINGS_PRINT.

La valeur par défaut est : NO.

WARN_FORMAT

La balise WARN_FORMAT détermine le format des messages d'avertissement que Doxygen peut produire. La chaîne doit contenir les balises $file, $line et $text, qui seront remplacées par le fichier et le numéro de ligne d'où provient l'avertissement et le texte de l'avertissement. Le format peut éventuellement contenir $version, qui sera remplacé par la version du fichier (si elle peut être obtenue via FILE_VERSION_FILTER)

Voir aussi

WARN_LINE_FORMAT

La valeur par défaut est : $file:$line: $text.

WARN_LINE_FORMAT

Dans la partie $text de la commande WARN_FORMAT, il est possible qu'une référence à un endroit plus spécifique soit donnée. Pour faciliter le passage à cet endroit (en dehors de Doxygen), l'utilisateur peut définir une chaîne « couper » / « coller » personnalisée.

Exemple :

WARN_LINE_FORMAT = "'vi $file +$line'"

Voir aussi

WARN_FORMAT

La valeur par défaut est : at line $line of file $file.

WARN_LOGFILE

La balise WARN_LOGFILE peut être utilisée pour spécifier un fichier dans lequel les messages d'avertissement et d'erreur doivent être écrits. Si elle est laissée vide, la sortie est écrite sur l'erreur standard (stderr). Si le fichier spécifié ne peut pas être ouvert pour l'écriture, les messages d'avertissement et d'erreur sont écrits sur l'erreur standard. Lorsque file - est spécifié, les messages d'avertissement et d'erreur sont écrits sur la sortie standard (stdout).

Options de configuration liées aux fichiers d'entrée

INPUT

La balise INPUT est utilisée pour spécifier les fichiers et/ou les répertoires qui contiennent les fichiers sources documentés. Vous pouvez saisir des noms de fichiers comme myfile.cpp ou des répertoires comme /usr/src/myproject. Séparez les fichiers ou les répertoires par des espaces. Voir aussi FILE_PATTERNS et EXTENSION_MAPPING

Note
Si cette balise est vide, le répertoire actuel est recherché.

INPUT_ENCODING

Cette balise peut être utilisée pour spécifier l'encodage des caractères des fichiers sources analysés par Doxygen. En interne, Doxygen utilise l'encodage UTF-8. Doxygen utilise libiconv (ou iconv intégré à libc) pour le transcodage. Consultez la documentation de libiconv pour obtenir la liste des encodages possibles.

Voir aussi

INPUT_FILE_ENCODING

La valeur par défaut est : UTF-8.

INPUT_FILE_ENCODING

Cette balise peut être utilisée pour spécifier l'encodage des caractères des fichiers sources analysés par Doxygen. La balise INPUT_FILE_ENCODING peut être utilisée pour spécifier l'encodage des caractères sur la base d'un modèle par fichier. Doxygen comparera le nom du fichier avec chaque modèle et appliquera l'encodage à la place de l'encodage par défaut INPUT_ENCODING s'il y a une correspondance. Les encodages de caractères sont une liste de la forme : pattern=encoding (comme *.php=ISO-8859-1).

Voir aussi

INPUT_ENCODING pour plus d'informations sur les encodages pris en charge.

FILE_PATTERNS

Si la valeur de la balise INPUT contient des répertoires, vous pouvez utiliser la balise FILE_PATTERNS pour spécifier un ou plusieurs modèles génériques (comme *.cpp et *.h) pour filtrer les fichiers sources dans les répertoires. Notez que pour les extensions personnalisées ou les extensions non directement prises en charge, vous devez également définir EXTENSION_MAPPING pour l'extension, sinon les fichiers ne sont pas lus par Doxygen. Notez que la liste des modèles de fichiers vérifiés par défaut peut différer de la liste des mappages d'extensions de fichiers par défaut. Si laissé vide, les modèles suivants sont testés : *.c, *.cc, *.cxx, *.cxxm, *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (à fournir comme commentaire Doxygen C), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf et *.ice.

RECURSIVE

La balise RECURSIVE peut être utilisée pour spécifier si les sous-répertoires doivent également être recherchés pour les fichiers d'entrée.

La valeur par défaut est : NO.

EXCLUDE

La balise EXCLUDE peut être utilisée pour spécifier les fichiers et/ou les répertoires qui doivent être exclus des fichiers source INPUT. De cette façon, vous pouvez facilement exclure un sous-répertoire d'une arborescence de répertoires dont la racine est spécifiée avec la balise INPUT. Notez que les chemins relatifs sont relatifs au répertoire à partir duquel Doxygen est exécuté.

EXCLUDE_SYMLINKS

La balise EXCLUDE_SYMLINKS peut être utilisée pour sélectionner si les fichiers ou les répertoires qui sont des liens symboliques (une fonctionnalité du système de fichiers Unix) sont exclus de l'entrée.

La valeur par défaut est : NO.

EXCLUDE_PATTERNS

Si la valeur de la balise INPUT contient des répertoires, vous pouvez utiliser la balise EXCLUDE_PATTERNS pour spécifier un ou plusieurs modèles génériques pour exclure certains fichiers de ces répertoires. Notez que les caractères génériques sont mis en correspondance avec le fichier avec le chemin absolu, donc pour exclure tous les répertoires de test, utilisez par exemple le modèle /test *

EXCLUDE_SYMBOLS

La balise EXCLUDE_SYMBOLS peut être utilisée pour spécifier un ou plusieurs noms de symboles (espaces de noms, classes, fonctions, etc.) qui doivent être exclus de la sortie. Le nom du symbole peut être un nom entièrement qualifié, un mot ou, si le caractère générique * est utilisé, une sous-chaîne. Exemples : ANamespace, AClass, ANamespace::AClass, ANamespace::*Test.

EXAMPLE_PATH

La balise EXAMPLE_PATH peut être utilisée pour spécifier un ou plusieurs fichiers ou répertoires contenant des fragments de code d'exemple qui sont inclus (voir la commande \include.

EXAMPLE_PATTERNS

Si la valeur de la balise EXAMPLE_PATH contient des répertoires, vous pouvez utiliser la balise EXAMPLE_PATTERNS pour spécifier un ou plusieurs modèles génériques (comme *.cpp et *.h) pour filtrer les fichiers sources dans les répertoires. Si ce champ est laissé vide, tous les fichiers sont inclus.

EXAMPLE_RECURSIVE

Si la balise EXAMPLE_RECURSIVE est définie sur YES, les sous-répertoires seront recherchés pour les fichiers d'entrée à utiliser avec les commandes \include ou \dontinclude, quelle que soit la valeur de la balise RECURSIVE.

La valeur par défaut est : NO.

IMAGE_PATH

La balise IMAGE_PATH peut être utilisée pour spécifier un ou plusieurs fichiers ou répertoires contenant des images à inclure dans la documentation (voir la commande \image).

INPUT_FILTER

La balise INPUT_FILTER peut être utilisée pour spécifier un programme que Doxygen doit invoquer pour filtrer chaque fichier d'entrée. Doxygen invoquera le programme de filtrage en exécutant (via popen()) la commande :
<filter> <input-file>
où <filter> est la valeur de la balise INPUT_FILTER et <input-file> est le nom d'un fichier d'entrée. Doxygen utilisera ensuite la sortie que le programme de filtrage écrit sur la sortie standard. Si FILTER_PATTERNS est spécifié, cette balise sera ignorée. Notez que le filtre ne doit pas ajouter ou supprimer de lignes ; il est appliqué avant que le code ne soit analysé, mais pas lorsque le code de sortie est généré. Si des lignes sont ajoutées ou supprimées, les ancres ne seront pas placées correctement. Notez que Doxygen utilisera les données traitées et écrites sur la sortie standard pour un traitement ultérieur. Par conséquent, rien d'autre, comme les instructions de débogage ou les commandes utilisées (donc dans le cas d'un fichier batch Windows, utilisez toujours @echo OFF), ne doit être écrit sur la sortie standard. Notez que pour les extensions personnalisées ou les extensions non directement prises en charge, vous devez également définir EXTENSION_MAPPING pour l'extension, sinon les fichiers ne sont pas correctement traités par Doxygen.

FILTER_PATTERNS

La balise FILTER_PATTERNS peut être utilisée pour spécifier des filtres sur la base d'un modèle par fichier. Doxygen comparera le nom de fichier avec chaque modèle et appliquera le filtre s'il y a une correspondance. Les filtres sont une liste de la forme : pattern=filter (comme *.cpp=my_cpp_filter). Voir INPUT_FILTER pour plus d'informations sur la façon dont les filtres sont utilisés. Si la balise FILTER_PATTERNS est vide ou si aucun des modèles ne correspond au nom de fichier, INPUT_FILTER est appliqué. Notez que pour les extensions personnalisées ou les extensions non directement prises en charge, vous devez également définir EXTENSION_MAPPING pour l'extension, sinon les fichiers ne sont pas correctement traités par Doxygen.

FILTER_SOURCE_FILES

Si la balise FILTER_SOURCE_FILES est définie sur YES, le filtre d'entrée (s'il est défini à l'aide de INPUT_FILTER) sera également utilisé pour filtrer les fichiers d'entrée utilisés pour produire les fichiers sources à parcourir (c'est-à-dire lorsque SOURCE_BROWSER est défini sur YES).

La valeur par défaut est : NO.

FILTER_SOURCE_PATTERNS

La balise FILTER_SOURCE_PATTERNS peut être utilisée pour spécifier des filtres source par modèle de fichier. Un modèle remplacera le paramètre de FILTER_PATTERN (le cas échéant) et il est également possible de désactiver le filtrage source pour un modèle spécifique à l'aide de *.ext= (donc sans nommer de filtre).

Cette balise nécessite que la balise FILTER_SOURCE_FILES soit définie sur YES.

USE_MDFILE_AS_MAINPAGE

Si la balise USE_MDFILE_AS_MAINPAGE fait référence au nom d'un fichier markdown qui fait partie de l'entrée, son contenu sera placé sur la page principale (index.html). Cela peut être utile si vous avez un projet sur GitHub par exemple et que vous souhaitez également réutiliser la page d'introduction pour la sortie Doxygen.

IMPLICIT_DIR_DOCS

Si la balise IMPLICIT_DIR_DOCS est définie sur YES, tout fichier README.md trouvé dans les sous-répertoires de la racine du projet est utilisé comme documentation pour ce sous-répertoire, sauf lorsque le fichier README.md commence par une commande \dir, \page ou \mainpage. Si elle est définie sur NO, le fichier README.md doit commencer par une commande \dir explicite pour être utilisé comme documentation de répertoire.

La valeur par défaut est : YES.

FORTRAN_COMMENT_AFTER

La norme Fortran spécifie que pour le code Fortran à format fixe, tous les caractères à partir de la position 72 doivent être considérés comme des commentaires. Une extension courante consiste à autoriser des lignes plus longues avant le début du commentaire automatique. Le paramètre FORTRAN_COMMENT_AFTER permettra également de traiter des lignes plus longues avant le début du commentaire automatique.

Valeur minimale : 7, valeur maximale : 10 000, valeur par défaut : 72.

Options de configuration liées à la navigation dans les sources

SOURCE_BROWSER

Si la balise SOURCE_BROWSER est définie sur YES, une liste de fichiers sources sera générée. Les entités documentées seront référencées avec ces sources. Remarque : pour supprimer tout le code source dans la sortie générée, assurez-vous que VERBATIM_HEADERS est également défini sur NO.

La valeur par défaut est : NO.

INLINE_SOURCES

La définition de la balise INLINE_SOURCES sur YES inclura le corps des fonctions, les macros multilignes, les énumérations ou les variables initialisées par liste directement dans la documentation.

La valeur par défaut est : NO.

STRIP_CODE_COMMENTS

La définition de la balise STRIP_CODE_COMMENTS sur YES demandera à Doxygen de masquer tous les blocs de commentaires spéciaux des fragments de code source générés. Les commentaires C, C++ et Fortran normaux resteront toujours visibles.

La valeur par défaut est : YES.

REFERENCED_BY_RELATION

Si la balise REFERENCED_BY_RELATION est définie sur YES, alors pour chaque entité documentée, toutes les fonctions documentées qui y font référence seront répertoriées.

La valeur par défaut est : NO.

REFERENCES_RELATION

Si la balise REFERENCES_RELATION est définie sur YES, alors pour chaque fonction documentée, toutes les entités documentées appelées/utilisées par cette fonction seront répertoriées.

La valeur par défaut est : NO.

REFERENCES_LINK_SOURCE

Si la balise REFERENCES_LINK_SOURCE est définie sur YES et la balise SOURCE_BROWSER sur YES, les hyperliens des fonctions des listes REFERENCES_RELATION et REFERENCED_BY_RELATION seront alors liés au code source. Sinon, ils seront liés à la documentation.

La valeur par défaut est : YES.

SOURCE_TOOLTIPS

Si SOURCE_TOOLTIPS est activé (valeur par défaut), le survol d'un hyperlien dans le code source affichera une info-bulle contenant des informations supplémentaires telles que le prototype, une brève description et des liens vers la définition et la documentation. Étant donné que cela rendra le fichier HTML plus volumineux et le chargement des fichiers volumineux un peu plus lent, vous pouvez choisir de désactiver cette fonctionnalité.

La valeur par défaut est : YES.

Cette balise nécessite que la balise SOURCE_BROWSER soit définie sur YES.

USE_HTAGS

Si la balise USE_HTAGS est définie sur YES, les références au code source pointeront vers le code HTML généré par l'outil htags(1) au lieu du navigateur de source intégré de Doxygen. L'outil htags fait partie du système global de balisage de source de GNU (voir https://www.gnu.org/software/global/global.html). Vous aurez besoin de la version 4.8.6 ou supérieure. Pour l'utiliser, procédez comme suit :

  1. Installez la dernière version de global
  2. Activez SOURCE_BROWSER et USE_HTAGS dans le fichier de configuration
  3. Assurez-vous que INPUT pointe vers la racine de l'arborescence source
  4. Exécutez doxygen normalement Doxygen invoquera htags (et cela invoquera à son tour gtags), ces outils doivent donc être disponibles à partir de la ligne de commande (c'est-à-dire dans le chemin de recherche). Résultat : au lieu du navigateur de source généré par Doxygen, les liens vers le code source pointeront désormais vers la sortie de htags.

La valeur par défaut est : NO.

Cette balise nécessite que la balise SOURCE_BROWSER soit définie sur YES.

VERBATIM_HEADERS

Si la balise VERBATIM_HEADERS est définie sur YES, Doxygen génèrera une copie littérale du fichier d'en-tête pour chaque classe pour laquelle une inclusion est spécifiée. Définissez sur NO pour désactiver cette option.

Voir aussi

Section \class.

La valeur par défaut est : YES.

CLANG_ASSISTED_PARSING

Si la balise CLANG_ASSISTED_PARSING est définie sur YES, Doxygen utilisera l'analyseur clang pour une analyse plus précise au prix d'une réduction des performances. Cela peut être particulièrement utile avec du code C++ riche en modèles pour lequel l'analyseur intégré de Doxygen ne dispose pas des informations de type nécessaires.

Note
La disponibilité de cette option dépend du fait que Doxygen ait été généré ou non avec l'option -Duse_libclang=ON pour CMake.

La valeur par défaut est : NO.

CLANG_ADD_INC_PATHS

Si la balise CLANG_ASSISTED_PARSING est définie sur YES et que la balise CLANG_ADD_INC_PATHS est définie sur YES, Doxygen ajoutera le répertoire de chaque entrée au chemin d'inclusion.

La valeur par défaut est : YES.

Cette balise nécessite que la balise CLANG_ASSISTED_PARSING soit définie sur YES.

CLANG_OPTIONS

Si l'analyse assistée par clang est activée, vous pouvez fournir au compilateur les options de ligne de commande que vous utiliseriez normalement lors de l'appel du compilateur. Notez que les chemins d'inclusion seront déjà définis par Doxygen pour les fichiers et répertoires spécifiés avec INPUT et INCLUDE_PATH.

Cette balise nécessite que la balise CLANG_ASSISTED_PARSING soit définie sur YES.

CLANG_DATABASE_PATH

Si l'analyse assistée par clang est activée, vous pouvez fournir à l'analyseur clang le chemin d'accès au répertoire contenant un fichier appelé compile_commands.json. Ce fichier est la base de données de compilation contenant les options utilisées lors de la création des fichiers sources. Cela équivaut à spécifier l'option -p à un outil clang, tel que clang-check. Ces options seront ensuite transmises à l'analyseur. Toutes les options spécifiées avec CLANG_OPTIONS seront également ajoutées.

Note
La disponibilité de cette option dépend du fait que Doxygen ait été généré ou non avec l'option -Duse_libclang=ON pour CMake.

Options de configuration liées à l'index alphabétique des classes

ALPHABETICAL_INDEX

Si la balise ALPHABETICAL_INDEX est définie sur YES, un index alphabétique de tous les composés sera généré. Activez cette option si le projet contient beaucoup de classes, de structures, d'unions ou d'interfaces.

La valeur par défaut est : YES.

IGNORE_PREFIX

La balise IGNORE_PREFIX peut être utilisée pour spécifier un préfixe (ou une liste de préfixes) à ignorer lors de la génération des en-têtes d'index. La balise IGNORE_PREFIX fonctionne pour les noms de classes, de fonctions et de membres. L'entité sera placée dans la liste alphabétique sous la première lettre du nom de l'entité qui reste après la suppression du préfixe.

Cette balise nécessite que la balise ALPHABETICAL_INDEX soit définie sur YES.

Options de configuration liées à la sortie HTML

GENERATE_HTML

Si la balise GENERATE_HTML est définie sur YES, Doxygen générera une sortie HTML

La valeur par défaut est : YES.

HTML_OUTPUT

La balise HTML_OUTPUT est utilisée pour spécifier où les documents HTML seront placés. Si un chemin relatif est saisi, la valeur de OUTPUT_DIRECTORY sera placée devant lui.

Le répertoire par défaut est : html.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_FILE_EXTENSION

La balise HTML_FILE_EXTENSION peut être utilisée pour spécifier l'extension de fichier pour chaque page HTML générée (par exemple : .htm, .php, .asp).

La valeur par défaut est : .html.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_HEADER

La balise HTML_HEADER peut être utilisée pour spécifier un fichier d'en-tête HTML défini par l'utilisateur pour chaque page HTML générée. Si la balise est laissée vide, Doxygen génère un en-tête standard. Pour obtenir un HTML valide, le fichier d'en-tête qui inclut tous les scripts et feuilles de style dont Doxygen a besoin, ce qui dépend des options de configuration utilisées (par exemple, le paramètre GENERATE_TREEVIEW). Il est fortement recommandé de commencer avec un en-tête par défaut en utilisant

doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile

puis de modifier le fichier new_header.html.

Voir également la section Utilisation de Doxygen pour plus d'informations sur la façon de générer l'en-tête par défaut que Doxygen utilise normalement

Note
L'en-tête est sujet à modification, vous devez donc généralement régénérer l'en-tête par défaut lors de la mise à niveau vers une version plus récente de Doxygen. Les marqueurs suivants ont une signification particulière dans l'en-tête et le pied de page :
$title
sera remplacé par le titre de la page.
$datetime
sera remplacé par la date et l'heure actuelles.
$date
sera remplacé par la date actuelle.
$time
sera remplacé par l'heure actuelle.
$year
sera remplacé par l'année en cours.
$showdate(<format>)
sera remplacé par la date et l'heure actuelles selon le format spécifié par <format> . Le <format> suit les règles spécifiées pour la commande \showdate à l'exception du fait qu'aucun ) n'est autorisé dans le <format> .
$doxygenversion
sera remplacé par la version de Doxygen
$projectname
sera remplacé par le nom du projet (voir PROJECT_NAME)
$projectnumber
sera remplacé par le numéro du projet (voir PROJECT_NUMBER)
$projectbrief
sera remplacé par la brève description du projet (voir PROJECT_BRIEF)
$projectlogo
sera remplacé par le logo du projet (voir PROJECT_LOGO)
$ generatedby
sera remplacé par la version dépendante de la langue de sortie du texte "Généré par" ou lorsque le TIMESTAMP est défini par la version dépendante de la langue de sortie du texte "Généré le $datetime pour $projectname by".
$stylesheet
sera remplacé par le paramètre HTML_STYLESHEET à moins qu'il ne soit vide ou le fichier, auquel cas il est remplacé par le paramètre par défaut `doxygen.css`.
$extrastylesheet
sera remplacé par le paramètre HTML_EXTRA_STYLESHEET incluant les balises HTML requises pour chaque feuille de style supplémentaire.
$treeview
sera remplacé par des liens vers le JavaScript et les feuilles de style nécessaires à l'arborescence de navigation (ou une chaîne vide lorsque GENERATE_TREEVIEW est désactivé).
$search
sera remplacé par des liens vers le JavaScript et les feuilles de style nécessaires au moteur de recherche (ou une chaîne vide lorsque SEARCHENGINE est désactivé).
$searchbox
sera remplacé par le code HTML nécessaire à l'affichage de la boîte de recherche (ou une chaîne vide lorsque SEARCHENGINE est désactivé).
$mathjax
sera remplacé par des liens vers le JavaScript et les feuilles de style nécessaires à la fonctionnalité MathJax (ou une chaîne vide lorsque USE_MATHJAX est désactivé). $relpath^
Si CREATE_SUBDIRS est activé, la commande $relpath^ peut être utilisée pour produire un chemin relatif vers la racine du répertoire de sortie HTML, par exemple utilisez $relpath^doxygen.css pour faire référence à la feuille de style standard.
$navpath
sera remplacé par un chemin comme requis par GENERATE_TREEVIEW

Pour gérer les différences de mise en page de l'en-tête et du pied de page qui dépendent des paramètres de configuration, l'en-tête peut également contenir des blocs spéciaux qui seront copiés dans la sortie ou ignorés en fonction de la configuration. Ces blocs ont la forme suivante :

<!--BEGIN BLOCKNAME-->
Un certain contexte copié lorsque la condition BLOCKNAME est remplie
<!--END BLOCKNAME-->
<!--BEGIN !BLOCKNAME-->
Un certain contexte copié lorsque la condition BLOCKNAME n'est pas remplie
<!--END !BLOCKNAME-->

Les noms de blocs suivants sont pris en charge :

DISABLE_INDEX

Le contenu de ce bloc est copié dans la sortie si l'option DISABLE_INDEX est activée (donc lorsque l'index est désactivé).

GENERATE_TREEVIEW

Le contenu de ce bloc est copié vers la sortie si l'option GENERATE_TREEVIEW est activée.

SEARCHENGINE

Le contenu de ce bloc est copié vers la sortie si l'option SEARCHENGINE est activée.

PROJECT_NAME

Le contenu du bloc est copié vers la sortie si l'option PROJECT_NAME n'est pas vide.

PROJECT_NUMBER

Le contenu du bloc est copié vers la sortie si l'option PROJECT_NUMBER n'est pas vide.

PROJECT_BRIEF

Le contenu du bloc est copié vers la sortie si l'option PROJECT_BRIEF n'est pas vide.

PROJECT_LOGO

Le contenu du bloc est copié vers la sortie si l'option PROJECT_LOGO n'est pas vide.

FULL_SIDEBAR

Le contenu du bloc est copié vers la sortie si les options FULL_SIDEBAR, DISABLE_INDEX et GENERATE_TREEVIEW sont toutes activées.

TITLEAREA

Le contenu de ce bloc est copié dans la sortie si un titre est visible en haut de chaque page. C'est le cas si PROJECT_NAME, PROJECT_BRIEF, PROJECT_LOGO sont renseignés ou si DISABLE_INDEX et SEARCHENGINE sont tous deux activés.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_FOOTER

La balise HTML_FOOTER peut être utilisée pour spécifier un pied de page HTML défini par l'utilisateur pour chaque page HTML générée. Si la balise est laissée vide, Doxygen génère un pied de page standard.

Voir HTML_HEADER pour plus d'informations sur la façon de générer un pied de page par défaut et sur les commandes spéciales qui peuvent être utilisées dans le pied de page.

Voir également la section Utilisation de Doxygen pour plus d'informations sur la façon de générer le pied de page par défaut que Doxygen utilise normalement.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_STYLESHEET

La balise HTML_STYLESHEET peut être utilisée pour spécifier une feuille de style en cascade définie par l'utilisateur qui est utilisée par chaque page HTML. Elle peut être utilisée pour affiner l'apparence de la sortie HTML. Si elle est laissée vide, Doxygen génère une feuille de style par défaut.

Voir également la section Utilisation de Doxygen pour plus d'informations sur la façon de générer la feuille de style que Doxygen utilise normalement.

Note
Il est recommandé d'utiliser HTML_EXTRA_STYLESHEET à la place de cette balise, car elle est plus robuste et cette balise (HTML_STYLESHEET) deviendra obsolète à l'avenir

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_EXTRA_STYLESHEET

La balise HTML_EXTRA_STYLESHEET peut être utilisée pour spécifier des feuilles de style en cascade supplémentaires définies par l'utilisateur qui sont incluses après les feuilles de style standard créées par Doxygen. En utilisant cette option, on peut outrepasser certains aspects du style. Il est préférable d'utiliser cette méthode plutôt que HTML_STYLESHEET car elle ne remplace pas la feuille de style standard et est donc plus robuste face aux mises à jour futures. Doxygen copiera les fichiers de feuille de style dans le répertoire de sortie.

Note
L'ordre des fichiers de feuille de style supplémentaires est important (par exemple, la dernière feuille de style de la liste remplace le paramètre des précédentes dans la liste).
Étant donné que le style des barres de défilement ne peut actuellement pas être remplacé dans Webkit/Chromium, le style sera laissé de côté dans le fichier doxygen.css par défaut si une ou plusieurs feuilles de style supplémentaires ont été spécifiées. Ainsi, si la personnalisation de la barre de défilement est souhaitée, elle doit être ajoutée explicitement. Voici un exemple de feuille de style qui donne à la zone de contenu une largeur fixe :

body {
background-color: #CCC;
color: black;
margin: 0;
}

div.contents {
margin-bottom: 10px;
padding: 12px;
margin-left: auto;
margin-right: auto;
largeur : 960 px ;
couleur d'arrière-plan : blanc ;
rayon de bordure : 8 px ;
}

#titlearea {
couleur d'arrière-plan : blanc ;
}

hr.footer {
affichage : aucun ;
}

.footer {
couleur d'arrière-plan : #AAA ;
}

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_EXTRA_FILES

La balise HTML_EXTRA_FILES peut être utilisée pour spécifier une ou plusieurs images supplémentaires ou d'autres fichiers sources qui doivent être copiés dans le répertoire de sortie HTML. Notez que ces fichiers seront copiés dans le répertoire de sortie HTML de base. Utilisez le marqueur $relpath^ dans les fichiers HTML_HEADER et/ou HTML_FOOTER pour charger ces fichiers. Dans le fichier HTML_STYLESHEET, utilisez uniquement le nom du fichier. Notez également que les fichiers seront copiés tels quels ; aucune commande ni marqueur n'est disponible.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_COLORSTYLE

La balise HTML_COLORSTYLE peut être utilisée pour spécifier si la sortie HTML générée doit être rendue avec un thème sombre ou clair.

Les valeurs possibles sont : LIGHT génère toujours une sortie en mode clair, DARK génère toujours une sortie en mode sombre, AUTO_LIGHT définit automatiquement le mode en fonction des préférences de l'utilisateur, utilise le mode clair si aucune préférence n'est définie (valeur par défaut), AUTO_DARK définit automatiquement le mode en fonction des préférences de l'utilisateur, utilise le mode sombre si aucune préférence n'est définie et TOGGLE permet à un utilisateur de basculer entre le mode clair et le mode sombre via un bouton.

La valeur par défaut est : AUTO_LIGHT.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_COLORSTYLE_HUE

La balise HTML_COLORSTYLE_HUE contrôle la couleur de la sortie HTML. Doxygen ajustera les couleurs de la feuille de style et des images d'arrière-plan en fonction de cette couleur. La teinte est spécifiée sous forme d'angle sur une roue chromatique, voir https://en.wikipedia.org/wiki/Hue pour plus d'informations. Par exemple, la valeur 0 représente le rouge, 60 le jaune, 120 le vert, 180 le cyan, 240 le bleu, 300 le violet et 360 le rouge à nouveau.

Valeur minimale : 0, valeur maximale : 359, valeur par défaut : 220.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_COLORSTYLE_SAT

La balise HTML_COLORSTYLE_SAT contrôle la pureté (ou la saturation) des couleurs dans la sortie HTML. Pour une valeur de 0, la sortie utilisera uniquement des niveaux de gris. Une valeur de 255 produira les couleurs les plus vives.

Valeur minimale : 0, valeur maximale : 255, valeur par défaut : 100.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_COLORSTYLE_GAMMA

La balise HTML_COLORSTYLE_GAMMA contrôle la correction gamma appliquée à la composante de luminance des couleurs dans la sortie HTML. Les valeurs inférieures à 100 éclaircissent progressivement la sortie, tandis que les valeurs supérieures à 100 la rendent plus sombre. La valeur divisée par 100 est le gamma réel appliqué, donc 80 représente un gamma de 0,8, la valeur 220 représente un gamma de 2,2 et 100 ne change pas le gamma.

Valeur minimale : 40, valeur maximale : 240, valeur par défaut : 80.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_DYNAMIC_MENUS

Si la balise HTML_DYNAMIC_MENUS est définie sur YES, la documentation HTML générée contiendra un index principal avec des menus de navigation verticaux créés dynamiquement via JavaScript. Si elle est désactivée, l'index de navigation sera composé de plusieurs niveaux d'onglets intégrés de manière statique dans chaque page HTML. Désactivez cette option pour prendre en charge les navigateurs qui n'ont pas JavaScript, comme le navigateur d'aide Qt.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_DYNAMIC_SECTIONS

Si la balise HTML_DYNAMIC_SECTIONS est définie sur YES, la documentation HTML générée contiendra des sections qui peuvent être masquées et affichées après le chargement de la page.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_CODE_FOLDING

Si la balise HTML_CODE_FOLDING est définie sur YES, les classes et les fonctions peuvent être pliées et développées de manière dynamique dans le code source HTML généré.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_COPY_CLIPBOARD

Si la balise HTML_COPY_CLIPBOARD est définie sur YES, Doxygen affichera une icône dans le coin supérieur droit des fragments de code et de texte qui permet à l'utilisateur de copier son contenu dans le presse-papiers. Notez que cela ne fonctionne que si le navigateur le prend en charge et que la page Web est diffusée via un contexte sécurisé, c'est-à-dire en utilisant le protocole https: ou file:.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_PROJECT_COOKIE

Doxygen stocke quelques paramètres de manière persistante dans le navigateur (via des cookies, par exemple). Par défaut, ces paramètres s'appliquent à toutes les pages HTML générées par Doxygen dans tous les projets. La balise HTML_PROJECT_COOKIE peut être utilisée pour stocker les paramètres sous une clé spécifique au projet, de sorte que les préférences de l'utilisateur soient stockées séparément.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_INDEX_NUM_ENTRIES

Avec HTML_INDEX_NUM_ENTRIES, on peut contrôler le nombre préféré d'entrées affichées dans les différents index structurés en arborescence initialement ; l'utilisateur peut développer et réduire les entrées de manière dynamique par la suite. Doxygen développera l'arborescence à un niveau tel qu'au plus le nombre spécifié d'entrées soit visible (à moins qu'une arborescence entièrement réduite ne dépasse déjà ce montant). Ainsi, définir le nombre d'entrées sur 1 produira une arborescence entièrement réduite par défaut. 0 est une valeur spéciale représentant un nombre infini d'entrées et produira une arborescence entièrement développée par défaut.

Valeur minimale : 0, valeur maximale : 9999, valeur par défaut : 100.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

GENERATE_DOCSET

Si la balise GENERATE_DOCSET est définie sur YES, des fichiers d'index supplémentaires seront générés et pourront être utilisés comme entrée pour l'environnement de développement intégré Xcode 3 d'Apple, introduit avec OSX 10.5 (Leopard). Pour créer un ensemble de documentation, Doxygen génère un Makefile dans le répertoire de sortie HTML. L'exécution de make produira le docset dans ce répertoire et l'exécution de make install installera le docset dans ~/Library/Developer/Shared/Documentation/DocSets afin que Xcode le trouve au démarrage. Voir https://developer.apple.com/library/archive/featuredarticles/DoxygenXcode/_index.html pour plus d'informations.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

DOCSET_FEEDNAME

Cette balise détermine le nom du flux du docset. Un flux de documentation fournit un cadre sous lequel plusieurs ensembles de documentation d'un seul fournisseur (comme une entreprise ou une suite de produits) peuvent être regroupés.

La valeur par défaut est : Doxygen generated docs.

Cette balise nécessite que la balise GENERATE_DOCSET soit définie sur YES.

DOCSET_FEEDURL

Cette balise détermine l'URL du flux de documents. Un flux de documentation fournit un cadre sous lequel plusieurs ensembles de documentation d'un seul fournisseur (comme une entreprise ou une suite de produits) peuvent être regroupés.

Cette balise nécessite que la balise GENERATE_DOCSET soit définie sur YES.

DOCSET_BUNDLE_ID

Cette balise spécifie une chaîne qui doit identifier de manière unique le bundle de documents. Il doit s'agir d'une chaîne de style nom de domaine inversé, par exemple com.mycompany.MyDocSet. Doxygen ajoutera .docset au nom.

La valeur par défaut est : org.doxygen.Project.

Cette balise nécessite que la balise GENERATE_DOCSET soit définie sur YES.

DOCSET_PUBLISHER_ID

La balise DOCSET_PUBLISHER_ID spécifie une chaîne qui doit identifier de manière unique l'éditeur de la documentation. Il doit s'agir d'une chaîne de style nom de domaine inversé, par exemple com.mycompany.MyDocSet.documentation.

La valeur par défaut est : org.doxygen.Publisher.

Cette balise nécessite que la balise GENERATE_DOCSET soit définie sur YES.

DOCSET_PUBLISHER_NAME

La balise DOCSET_PUBLISHER_NAME identifie l'éditeur de la documentation.

La valeur par défaut est : Publisher.

Cette balise nécessite que la balise GENERATE_DOCSET soit définie sur YES.

GENERATE_HTMLHELP

Si la balise GENERATE_HTMLHELP est définie sur YES, Doxygen génère trois fichiers d'index HTML supplémentaires : index.hhp, index.hhc et index.hhk. Le fichier index.hhp est un fichier de projet qui peut être lu par l'atelier d'aide HTML de Microsoft sous Windows. Début 2021, Microsoft a mis hors ligne la page d'origine, avec notamment les liens de téléchargement (l'atelier d'aide HTML était déjà en mode maintenance depuis de nombreuses années). Vous pouvez télécharger l'atelier d'aide HTML à partir des archives Web sur installation d'exécutable. L'atelier d'aide HTML contient un compilateur capable de convertir toutes les sorties HTML générées par Doxygen en un seul fichier HTML compilé (.chm). Les fichiers HTML compilés sont désormais utilisés comme format d'aide Windows 98 et remplaceront à l'avenir l'ancien format d'aide Windows (.hlp) sur toutes les plates-formes Windows. Les fichiers HTML compressés contiennent également un index, une table des matières et vous pouvez rechercher des mots dans la documentation. L'atelier HTML contient également une visionneuse pour les fichiers HTML compressés.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

CHM_FILE

La balise CHM_FILE peut être utilisée pour spécifier le nom de fichier du fichier .chm résultant. Vous pouvez ajouter un chemin devant le fichier si le résultat ne doit pas être écrit dans le répertoire de sortie HTML.

Cette balise nécessite que la balise GENERATE_HTMLHELP soit définie sur YES.

HHC_LOCATION

La balise HHC_LOCATION peut être utilisée pour spécifier l'emplacement (chemin absolu incluant le nom de fichier) du compilateur d'aide HTML (hhc.exe). Si elle n'est pas vide, Doxygen essaiera d'exécuter le compilateur d'aide HTML sur l'index.hhp généré.

Le fichier doit être spécifié avec le chemin complet.

C>ette balise nécessite que la balise GENERATE_HTMLHELP soit définie sur YES.

GENERATE_CHI

L'indicateur GENERATE_CHI contrôle si un fichier d'index .chi séparé est généré (YES) ou s'il doit être inclus dans le fichier .chm principal (NO).

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTMLHELP soit définie sur YES.

CHM_INDEX_ENCODING

Le CHM_INDEX_ENCODING est utilisé pour encoder l'index HtmlHelp (hhk), le contenu (hhc) et le contenu du fichier de projet.

Cette balise nécessite que la balise GENERATE_HTMLHELP soit définie sur YES.

BINARY_TOC

L'indicateur BINARY_TOC contrôle si une table des matières binaire est générée (YES) ou une table des matières normale (NO) dans le fichier .chm. De plus, il active les boutons Précédent et Suivant.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTMLHELP soit définie sur YES.

TOC_EXPAND

L'indicateur TOC_EXPAND peut être défini sur YES pour ajouter des éléments supplémentaires pour les membres du groupe à la table des matières de la documentation d'aide HTML et à l'arborescence.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTMLHELP soit définie sur YES.

SITEMAP_URL

La balise SITEMAP_URL est utilisée pour spécifier l'URL complète de l'emplacement où la documentation générée sera placée sur le serveur par l'utilisateur lors du déploiement de la documentation. Le plan de site généré est appelé sitemap.xml et placé dans le répertoire spécifié par HTML_OUTPUT. Si aucun SITEMAP_URL n'est spécifié, aucun plan de site n'est généré. Pour plus d'informations sur le protocole de plan de site, consultez https://www.sitemaps.org

Cette balise nécessite que la balise GENERATE_HTMLHELP soit définie sur YES.

GENERATE_QHP

Si la balise GENERATE_QHP est définie sur YES et que QHP_NAMESPACE et QHP_VIRTUAL_FOLDER sont définis, un fichier d'index supplémentaire sera généré qui peut être utilisé comme entrée pour le qhelpgenerator de Qt pour générer une aide compressée Qt ​​(.qch) de la documentation HTML générée.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

QCH_FILE

Si la balise QHG_LOCATION est spécifiée, la balise QCH_FILE peut être utilisée pour spécifier le nom de fichier du fichier .qch résultant. Le chemin spécifié est relatif au dossier de sortie HTML.

Cette balise nécessite que la balise GENERATE_QHP soit définie sur YES.

QHP_NAMESPACE

La balise QHP_NAMESPACE spécifie l'espace de noms à utiliser lors de la génération de la sortie du projet Qt Help. Pour plus d'informations, consultez Projet Qt Help / Espace de noms.

La valeur par défaut est : org.doxygen.Project.

Cette balise nécessite que la balise GENERATE_QHP soit définie sur YES.

QHP_VIRTUAL_FOLDER

La balise QHP_VIRTUAL_FOLDER spécifie l'espace de noms à utiliser lors de la génération de la sortie du projet Qt Help. Pour plus d'informations, consultez Projet Qt Help / Dossiers virtuels.

La valeur par défaut est : doc.

Cette balise nécessite que la balise GENERATE_QHP soit définie sur YES.

QHP_CUST_FILTER_NAME

Si la balise QHP_CUST_FILTER_NAME est définie, elle spécifie le nom d'un filtre personnalisé à ajouter. Pour plus d'informations, consultez le projet Qt Help / Filtres personnalisés.

Cette balise nécessite que la baliseGENERATE_QHP soit définie sur YES.

QHP_CUST_FILTER_ATTRS

La balise QHP_CUST_FILTER_ATTRS spécifie la liste des attributs du filtre personnalisé à ajouter. Pour plus d'informations, consultez le projet Qt Help / Filtres personnalisés.

Cette balise nécessite que la balise GENERATE_QHP soit définie sur YES.

QHP_SECT_FILTER_ATTRS

La balise QHP_SECT_FILTER_ATTRS spécifie la liste des attributs auxquels correspond la section de filtre de ce projet. Projet Qt Help / Attributs de filtre.

Cette balise nécessite que la balise GENERATE_QHP soit définie sur YES.

QHG_LOCATION

La balise QHG_LOCATION peut être utilisée pour spécifier l'emplacement (chemin absolu incluant le nom de fichier) du qhelpgenerator de Qt. Si elle n'est pas vide, Doxygen essaiera d'exécuter qhelpgenerator sur le fichier .qhp généré.

Cette balise nécessite que la balise GENERATE_QHP soit définie sur YES.

GENERATE_ECLIPSEHELP

Si la balise GENERATE_ECLIPSEHELP est définie sur YES, des fichiers d'index supplémentaires seront générés, avec les fichiers HTML, ils forment un plugin d'aide Eclipse.

Pour installer ce plugin et le rendre disponible dans le menu du contenu de l'aide dans Eclipse, le contenu du répertoire contenant les fichiers HTML et XML doit être copié dans le répertoire des plugins d'Eclipse. Le nom du répertoire dans le répertoire des plugins doit être le même que la valeur ECLIPSE_DOC_ID.

Après la copie, Eclipse doit être redémarré avant que l'aide n'apparaisse.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

ECLIPSE_DOC_ID

Un identifiant unique pour le plug-in d'aide Eclipse. Lors de l'installation du plug-in, le nom du répertoire contenant les fichiers HTML et XML doit également avoir ce nom. Chaque ensemble de documentation doit avoir son propre identifiant.

La valeur par défaut est : org.doxygen.Project.

Cette balise nécessite que la balise GENERATE_ECLIPSEHELP soit définie sur YES.

DISABLE_INDEX

Si vous souhaitez avoir un contrôle total sur la mise en page des pages HTML générées, il peut être nécessaire de désactiver l'index et de le remplacer par le vôtre. La balise DISABLE_INDEX peut être utilisée pour activer/désactiver l'index condensé (onglets) en haut de chaque page HTML. Une valeur de NO active l'index et la valeur YES le désactive. Étant donné que les onglets de l'index contiennent les mêmes informations que l'arborescence de navigation, vous pouvez définir cette option sur YES si vous définissez également GENERATE_TREEVIEW sur YES.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

GENERATE_TREEVIEW

La balise GENERATE_TREEVIEW est utilisée pour spécifier si une structure d'index de type arborescence doit être générée pour afficher des informations hiérarchiques. Si la valeur de la balise est définie sur YES, un panneau latéral contenant une structure d'index de type arborescence sera généré (tout comme celle générée pour l'aide HTML). Pour que cela fonctionne, un navigateur prenant en charge JavaScript, DHTML, CSS et les cadres est nécessaire (c'est-à-dire tout navigateur moderne). Les utilisateurs de Windows ont probablement intérêt à utiliser la fonction d'aide HTML.

Via des feuilles de style personnalisées (voir HTML_EXTRA_STYLESHEET), on peut affiner davantage l'apparence de l'index (voir Affiner la sortie). À titre d'exemple, la feuille de style par défaut générée par Doxygen contient un exemple qui montre comment placer une image à la racine de l'arborescence au lieu du PROJECT_NAME.

Étant donné que l'arborescence contient essentiellement les mêmes informations que l'index des onglets, vous pouvez envisager de définir DISABLE_INDEX sur YES lors de l'activation de cette option.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

PAGE_OUTLINE_PANEL

Lorsque GENERATE_TREEVIEW est défini sur YES, l'option PAGE_OUTLINE_PANEL détermine si un panneau de navigation supplémentaire est affiché sur le côté droit de l'écran, affichant un aperçu du contenu de la page principale, comme par exemple https://developer.android.com/reference.

Si l'option GENERATE_TREEVIEW est définie sur NO, cette option n'a aucun effet.

La valeur par défaut est : OUI.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

FULL_SIDEBAR

Lorsque GENERATE_TREEVIEW et DISABLE_INDEX sont définis sur YES, l'option FULL_SIDEBAR détermine si la barre latérale est limitée à la zone d'arborescence (valeur NO) ou si elle doit s'étendre sur toute la hauteur de la fenêtre (valeur YES). La définition de cette option sur YES donne une mise en page similaire à https://docs.readthedocs.io avec plus d'espace pour le contenu, mais moins d'espace pour le logo, le titre et la description du projet.

Si GENERATE_TREEVIEW ou DISABLE_INDEX est défini sur NO, cette option n'a aucun effet.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

ENUM_VALUES_PER_LINE

La balise ENUM_VALUES_PER_LINE peut être utilisée pour définir le nombre de valeurs d'énumération que Doxygen regroupera sur une ligne dans la documentation HTML générée. Notez qu'une valeur de 0 supprimera complètement l'affichage des valeurs d'énumération dans la section de présentation.

Valeur minimale : 0, valeur maximale : 20, valeur par défaut : 4.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

SHOW_ENUM_VALUES

Lorsque la balise SHOW_ENUM_VALUES est définie, doxygen affichera les valeurs d'énumération spécifiées en plus des mnémoniques d'énumération.

La valeur par défaut est : NO.

TREEVIEW_WIDTH

Si l'arborescence est activée (voir GENERATE_TREEVIEW), cette balise peut être utilisée pour définir la largeur initiale (en pixels) du cadre dans lequel l'arbre est affiché.

Valeur minimale : 0, valeur maximale : 1500, valeur par défaut : 250.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

EXT_LINKS_IN_WINDOW

Si l'option EXT_LINKS_IN_WINDOW est définie sur YES, Doxygen ouvrira les liens vers les symboles externes importés via des fichiers de balises dans une fenêtre séparée.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

OBFUSCATE_EMAILS

Si la balise OBFUSCATE_EMAILS est définie sur YES, Doxygen masquera les adresses e-mail.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

HTML_FORMULA_FORMAT

Si l'option HTML_FORMULA_FORMAT est définie sur svg, Doxygen utilisera l'outil pdf2svg (voir https://github.com/dawbarton/pdf2svg) ou inkscape (voir https://inkscape.org) pour générer des formules sous forme d'images SVG au lieu de PNG pour la sortie HTML. Ces images seront généralement plus belles dans des résolutions mises à l'échelle.

Les valeurs possibles sont : png (par défaut) et svg (plus joli mais nécessite l'outil pdf2svg ou inkscape).

La valeur par défaut est : png.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

FORMULA_FONTSIZE

Utilisez cette balise pour modifier la taille de police des formules latex incluses sous forme d'images dans la documentation HTML. Lorsque vous modifiez la taille de police après une exécution réussie de Doxygen, vous devez supprimer manuellement toutes les images form_*.png du répertoire de sortie HTML pour forcer leur régénération.

Valeur minimale : 8, valeur maximale : 50, valeur par défaut : 10.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

FORMULA_MACROFILE

L'option FORMULA_MACROFILE peut contenir les commandes latex \newcommand et \renewcommand pour créer de nouvelles commandes latex à utiliser dans les formules comme blocs de construction. Voir la section Inclure des formules pour plus de détails.

USE_MATHJAX

Activez l'option USE_MATHJAX pour restituer les formules latex à l'aide de MathJax (voir https://www.mathjax.org) qui utilise JavaScript côté client pour le rendu au lieu d'utiliser des bitmaps pré-rendus. Utilisez cette option si vous n'avez pas installé latex ou si vous souhaitez que les formules soient plus jolies dans la sortie HTML. Lorsque cette option est activée, vous devrez peut-être également installer MathJax séparément et configurer le chemin d'accès à l'aide de l'option MATHJAX_RELPATH.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

MATHJAX_VERSION

Avec MATHJAX_VERSION, il est possible de spécifier la version de MathJax à utiliser. Notez que les différentes versions de MathJax ont des exigences différentes en ce qui concerne les différents paramètres, il est donc possible que d'autres paramètres de MathJax doivent également être modifiés lors du basculement entre les différentes versions de MathJax.

Les valeurs possibles sont : MathJax_2 et MathJax_3.

La valeur par défaut est : MathJax_2.

Cette balise nécessite que la balise USE_MATHJAX soit définie sur YES.

MATHJAX_FORMAT

Lorsque MathJax est activé, vous pouvez définir le format de sortie par défaut à utiliser pour la sortie MathJax. Pour plus de détails sur le format de sortie, voir MathJax version 2 et MathJax version 3.

Les valeurs possibles sont : HTML-CSS (qui est plus lent, mais offre la meilleure compatibilité. Il s'agit du nom de Mathjax version 2, pour MathJax version 3, il sera traduit en chtml), NativeMML (c'est-à-dire MathML. Uniquement pris en charge pour MathJax 2. Pour MathJax version 3, chtml sera utilisé à la place.), chtml (il s'agit du nom de Mathjax version 3, pour MathJax version 2, il sera traduit en HTML-CSS) et SVG.

La valeur par défaut est : HTML-CSS.

Cette balise nécessite que la balise USE_MATHJAX soit définie sur YES.

MATHJAX_RELPATH

Lorsque MathJax est activé, vous devez spécifier l'emplacement relatif au répertoire de sortie HTML à l'aide de l'option MATHJAX_RELPATH. Le répertoire de destination doit contenir le script MathJax.js. Par exemple, si le répertoire mathjax est situé au même niveau que le répertoire de sortie HTML, MATHJAX_RELPATH doit être ../mathjax. La valeur par défaut pointe vers le réseau de diffusion de contenu MathJax afin que vous puissiez voir rapidement le résultat sans installer MathJax. Cependant, il est fortement recommandé d'installer une copie locale de MathJax à partir de https://www.mathjax.org avant le déploiement.

La valeur par défaut est :

Cette balise nécessite que la balise USE_MATHJAX soit définie sur YES.

MATHJAX_EXTENSIONS

La balise MATHJAX_EXTENSIONS peut être utilisée pour spécifier un ou plusieurs noms d'extension MathJax qui doivent être activés pendant le rendu MathJax. Par exemple pour la version 2 de MathJax (voir https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions) :

MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols

Par exemple pour la version 3 de MathJax (voir http://docs.mathjax.org/en/latest/input/tex/extensions/index.html) :

MATHJAX_EXTENSIONS = ams

Cette balise nécessite que la balise USE_MATHJAX soit définie sur YES.

MATHJAX_CODEFILE

La balise MATHJAX_CODEFILE peut être utilisée pour spécifier un fichier avec des morceaux de code JavaScript qui seront utilisés au démarrage du code MathJax. Consultez le site MathJax pour plus de détails. À titre d'exemple, pour désactiver l'élément de menu « Math Renderer » dans le menu « Math Settings » de MathJax :

MATHJAX_CODEFILE = disableRenderer.js

avec dans le fichier disableRenderer.js :

MathJax.Hub.Config({
   menuSettings: {
      showRenderer: false,
   }
});

Cette balise nécessite que la balise USE_MATHJAX soit définie sur YES.

SEARCHENGINE

Lorsque la balise SEARCHENGINE est activée, Doxygen génère une zone de recherche pour la sortie HTML. Le moteur de recherche sous-jacent utilise JavaScript et DHTML et devrait fonctionner sur n'importe quel navigateur moderne. Notez que lorsque vous utilisez l'aide HTML (GENERATE_HTMLHELP), l'aide Qt (GENERATE_QHP) ou les docsets (GENERATE_DOCSET), il existe déjà une fonction de recherche, celle-ci doit donc généralement être désactivée. Pour les projets de grande envergure, le moteur de recherche basé sur JavaScript peut être lent, alors l'activation de SERVER_BASED_SEARCH peut fournir une meilleure solution.

Il est possible d'effectuer une recherche à l'aide du clavier ; pour accéder à la zone de recherche, utilisez <touche d'accès> + S (la <touche d'accès> dépend du système d'exploitation et du navigateur, mais il s'agit généralement de <CTRL>, <ALT>/<option> ou des deux). Dans la zone de recherche, utilisez la <touche de curseur vers le bas> pour accéder à la fenêtre des résultats de la recherche, les résultats peuvent être parcourus à l'aide des <touches de curseur>. Appuyez sur <Entrée> pour sélectionner un élément ou sur <Échap> pour annuler la recherche. Les options de filtre peuvent être sélectionnées lorsque le curseur se trouve dans la zone de recherche en appuyant sur <Maj>+<curseur vers le bas>. Ici aussi, utilisez les <touches de curseur> pour sélectionner un filtre et <Entrée> ou <Échap> pour activer ou annuler l'option de filtre.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_HTML soit définie sur YES.

SERVER_BASED_SEARCH

Lorsque la balise SERVER_BASED_SEARCH est activée, le moteur de recherche sera implémenté à l'aide d'un serveur Web au lieu d'un client Web utilisant JavaScript.

Il existe deux types de recherche basée sur un serveur Web en fonction du paramètre EXTERNAL_SEARCH. Lorsqu'il est désactivé, Doxygen génère un script PHP pour la recherche et un fichier d'index utilisé par le script. Lorsque EXTERNAL_SEARCH est activé, l'indexation et la recherche doivent être fournies par des outils externes. Voir la section Indexation et recherche externes pour plus de détails.

La valeur par défaut est : NO.

Cette balise nécessite que la balise SEARCHENGINE soit définie sur YES.

EXTERNAL_SEARCH

Lorsque la balise EXTERNAL_SEARCH est activée, Doxygen ne génère plus le script PHP pour la recherche. Au lieu de cela, les résultats de la recherche sont écrits dans un fichier XML qui doit être traité par un indexeur externe. Doxygen invoquera un moteur de recherche externe pointé par l'option SEARCHENGINE_URL pour obtenir les résultats de la recherche. Doxygen est livré avec un exemple d'indexeur (doxyindexer) et de moteur de recherche (doxysearch.cgi) qui sont basés sur la bibliothèque de moteurs de recherche open source Xapian. Voir la section Indexation et recherche externes pour plus de détails.

La valeur par défaut est : NO.

Cette balise nécessite que la balise SEARCHENGINE soit définie sur YES.

SEARCHENGINE_URL

SEARCHENGINE_URL doit pointer vers un moteur de recherche hébergé par un serveur Web qui renverra les résultats de la recherche lorsque EXTERNAL_SEARCH est activé. Doxygen est livré avec un exemple d'indexeur (doxyindexer) et un moteur de recherche (doxysearch.cgi) qui sont basés sur la bibliothèque de moteurs de recherche open source Xapian. Voir la section Indexation et recherche externes pour plus de détails.

Cette balise nécessite que la balise SEARCHENGINE soit définie sur YES.

SEARCHDATA_FILE

Lorsque SERVER_BASED_SEARCH et EXTERNAL_SEARCH sont tous deux activés, les données de recherche non indexées sont écrites dans un fichier pour être indexées par un outil externe. Avec la balise SEARCHDATA_FILE, le nom de ce fichier peut être spécifié.

Le fichier par défaut est : searchdata.xml.

Cette balise nécessite que la balise SEARCHENGINE soit définie sur YES.

EXTERNAL_SEARCH_ID

Lorsque SERVER_BASED_SEARCH et EXTERNAL_SEARCH sont tous deux activés, la balise EXTERNAL_SEARCH_ID peut être utilisée comme identifiant pour le projet. Ceci est utile en combinaison avec EXTRA_SEARCH_MAPPINGS pour rechercher dans plusieurs projets et rediriger les résultats vers le bon projet.

Cette balise nécessite que la balise SEARCHENGINE soit définie sur YES.

EXTRA_SEARCH_MAPPINGS

La balise EXTRA_SEARCH_MAPPINGS peut être utilisée pour permettre la recherche dans des projets Doxygen autres que celui défini par ce fichier de configuration, mais qui sont tous ajoutés au même index de recherche externe. Chaque projet doit avoir un identifiant unique défini via EXTERNAL_SEARCH_ID. Le mappage de recherche mappe ensuite l'identifiant à un emplacement relatif où la documentation peut être trouvée.

Le format est :

EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...

Cette balise nécessite que la balise SEARCHENGINE soit définie sur YES.

Options de configuration liées à la sortie LaTeX

GENERATE_LATEX

Si la balise GENERATE_LATEX est définie sur YES, Doxygen générera la sortie latex.

La valeur par défaut est : YES.

LATEX_OUTPUT

La balise LATEX_OUTPUT est utilisée pour spécifier où les documents latex seront placés. Si un chemin relatif est saisi, la valeur de OUTPUT_DIRECTORY sera placée devant celui-ci.

Le répertoire par défaut est : latex.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_CMD_NAME

La balise LATEX_CMD_NAME peut être utilisée pour spécifier le nom de la commande latex à invoquer. Notez que lorsque USE_PDFLATEX n'est pas activé, la valeur par défaut est latex. Lorsque USE_PDFLATEX est activé, la valeur par défaut est pdflatex. Dans le dernier cas, latex est choisi, il est remplacé par pdflatex. Pour des langues de sortie spécifiques, la valeur par défaut peut avoir été définie différemment, cela dépend de l'implémentation de la langue de sortie.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

MAKEINDEX_CMD_NAME

La balise MAKEINDEX_CMD_NAME peut être utilisée pour spécifier le nom de la commande pour générer l'index pour latex.

Note
Cette balise est utilisée dans le Makefile / make.bat.

Voir aussi

LATEX_MAKEINDEX_CMD pour la partie dans le fichier de sortie généré (.tex).

Le fichier par défaut est : makeindex.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_MAKEINDEX_CMD

La balise LATEX_MAKEINDEX_CMD peut être utilisée pour spécifier le nom de la commande pour générer l'index pour latex. S'il n'y a pas de barre oblique inverse (\) comme premier caractère, elle sera automatiquement ajoutée dans le code latex.

Note
Cette balise est utilisée dans le fichier de sortie généré (.tex).

Voir aussi

MAKEINDEX_CMD_NAME pour la partie dans le Makefile / make.bat.

La valeur par défaut est : makeindex.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

COMPACT_LATEX

Si la balise COMPACT_LATEX est définie sur YES, Doxygen génère des documents latex plus compacts. Cela peut être utile pour les petits projets et peut aider à sauver certaines arborescences en général.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

PAPER_TYPE

La balise PAPER_TYPE peut être utilisée pour définir le type de papier utilisé par l'imprimante.

Les valeurs possibles sont : a4 (210 x 297 mm), lettre (8,5 x 11 pouces), légal (8,5 x 14 pouces) et exécutif (7,25 x 10,5 pouces).

La valeur par défaut est : a4.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

EXTRA_PACKAGES

La balise EXTRA_PACKAGES peut être utilisée pour spécifier un ou plusieurs noms de paquets latex qui doivent être inclus dans la sortie latex. Le paquet peut être spécifié uniquement par son nom ou avec la syntaxe correcte pour être utilisé avec la commande latex \usepackage.

Pour obtenir la police de caractères times par exemple, vous pouvez spécifier :

EXTRA_PACKAGES=times
  ou
EXTRA_PACKAGES={times}

Pour utiliser l'option intlimits avec le package amsmath, vous pouvez spécifier :

EXTRA_PACKAGES=[intlimits]{amsmath}

Si ce champ est laissé vide, aucun package supplémentaire ne sera inclus.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_HEADER

La balise LATEX_HEADER peut être utilisée pour spécifier un en-tête latex défini par l'utilisateur pour le document latex généré. L'en-tête doit contenir tout jusqu'au premier chapitre. S'il est laissé vide, Doxygen générera un en-tête standard.

Il est fortement recommandé de commencer avec un en-tête par défaut en utilisant

doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty

puis de modifier le fichier new_header.tex.

Consultez également la section Utilisation de Doxygen pour savoir comment générer l'en-tête par défaut que Doxygen utilise normalement.

Remarque : n'utilisez un en-tête défini par l'utilisateur que si vous savez ce que vous faites !

Note
L'en-tête est sujet à changement, vous devez donc généralement régénérer l'en-tête par défaut lors de la mise à niveau vers une version plus récente de Doxygen. Les commandes suivantes ont une signification particulière dans l'en-tête (et le pied de page) :
$title
sera remplacé par le nom du projet.
$datetime
sera remplacé par la date et l'heure actuelles.
$date
sera remplacé par la date actuelle.
$time
sera remplacé par l'heure actuelle.
$year
sera remplacé par l'année en cours.
$showdate(<format>)
sera remplacé par la date et l'heure actuelles selon le format spécifié par <format>. Le <format> suit les règles spécifiées pour la commande \showdate à l'exception du fait qu'aucun ) n'est autorisé dans le <format>.
$doxygenversion
sera remplacé par la version de Doxygen
$projectname
sera remplacé par le nom du projet (voir PROJECT_NAME)
$projectnumber
sera remplacé par le numéro du projet (voir PROJECT_NUMBER)
$projectbrief
sera remplacé par la brève description du projet (voir PROJECT_BRIEF)
$projectlogo
sera remplacé par le logo du projet (voir PROJECT_LOGO)
$latexdocumentpre
sera remplacé par un paramètre dépendant de la langue de sortie, par exemple, intégrer l'intégralité du document dans un environnement spécial (pour le chinois, le japonais, etc.) Généralement utilisé avec $latexdocumentpost dans le pied de page.
$latexdocumentpost
sera remplacé par un paramètre dépendant de la langue de sortie, par exemple, intégrer l'intégralité du document dans un environnement spécial (pour le chinois, le japonais, etc.) Généralement utilisé avec $latexdocumentpre dans l'en-tête.
$generatedby
sera remplacé par la version de sortie dépendante de la langue du texte "Généré par" ou lorsque le TIMESTAMP est défini par la version de sortie dépendante de la langue du texte "Généré le $datetime pour $projectname par".
$latexcitereference
sera remplacé par la version de sortie dépendante de la langue du mot "Bibliographie". Ce paramètre est généralement utilisé en combinaison avec le nom de bloc CITATIONS_PRESENT.
$latexbibstyle
sera remplacé par le style bib latex à utiliser tel que défini par LATEX_BIB_STYLE, au cas où rien n'est défini, le style bib plain est utilisé. Ce paramètre est généralement utilisé en combinaison avec le nom de bloc CITATIONS_PRESENT.
$latexbibfiles
sera remplacé par la liste séparée par des virgules des fichiers bib. telle que définie par CITE_BIB_FILES (si nécessaire, un .bib manquant est automatiquement ajouté). Ce paramètre est généralement utilisé en combinaison avec le nom de bloc CITATIONS_PRESENT.
$papertype
sera remplacé par le type de papier défini dans PAPER_TYPE et le mot "paper" lui est directement ajouté pour avoir un type de papier logo latex correct.
$langISO
sera remplacé par le nom de la langue ISO.
$languagesupport
sera remplacé par un paramètre dépendant de la langue de sortie des packages requis pour traduire les termes de la langue spécifiée.
$latexfontenc
sera remplacé par un paramètre dépendant de la langue de sortie du codage de police à utiliser. Ce paramètre est généralement utilisé en combinaison avec le nom de bloc LATEX_FONTENC.
$latexfont
sera remplacé par un paramètre dépendant de la langue de sortie des polices à utiliser.
$latexemojidirectory
sera remplacé par le répertoire défini dans LATEX_EMOJI_DIRECTORY avec les barres obliques inversées remplacées par des barres obliques (donc utilisables par logo latex). Si LATEX_EMOJI_DIRECTORY est vide, le répertoire actuel sera utilisé.
$makeindex
sera remplacé par la commande définie dans LATEX_MAKEINDEX_CMD. La commande ne commence alors pas par une barre oblique inverse, une barre oblique inverse est automatiquement ajoutée au début. Si le paramètre est vide, la commande \makeindex est utilisée.
$extralatexpackages
sera remplacé par les commandes permettant d'utiliser les packages définis dans EXTRA_PACKAGES.
$extralatexstylesheet
sera remplacé par les commandes permettant d'utiliser les packages définis dans LATEX_EXTRA_STYLESHEET (lorsque l'extension est l'extension par défaut, .sty, cette extension est supprimée pour le nom du package).
$latexspecialformulachars
sera remplacé par le code de certains caractères Unicode spéciaux qui sont couramment utilisés (c'est-à-dire l'exposant moins, l'exposant 2 et l'exposant 3).
$formulamacrofile
sera remplacé par le nom du fichier tel que défini dans FORMULA_MACROFILE. Ce paramètre est généralement utilisé en combinaison avec le nom de bloc FORMULA_MACROFILE.

Pour gérer les différences de mise en page de l'en-tête et du pied de page qui dépendent des paramètres de configuration, l'en-tête et le pied de page peuvent également contenir des blocs spéciaux qui seront copiés dans la sortie ou ignorés en fonction de la configuration. Ces blocs ont la forme suivante :

%%BEGIN BLOCKNAME
Un contexte copié lorsque la condition BLOCKNAME est remplie
%%END BLOCKNAME
%%BEGIN !BLOCKNAME
Un contexte copié lorsque la condition BLOCKNAME n'est pas remplie
%%END !BLOCKNAME

Les noms de blocs suivants sont définis en fonction des paramètres utilisés dans le fichier de configuration :

COMPACT_LATEX

Le contenu de ce bloc est copié dans la sortie lorsque l'option COMPACT_LATEX est activée.

PDF_HYPERLINKS

Le contenu de ce bloc est copié dans la sortie lorsque l'option PDF_HYPERLINKS est activée.

USE_PDFLATEX

Le contenu de ce bloc est copié dans la sortie lorsque l'option USE_PDFLATEX est activée.

LATEX_BATCHMODE

Le contenu de ce bloc est copié vers la sortie lorsque l'option LATEX_BATCHMODE est activée.

TIMESTAMP

Le contenu de ce bloc est copié vers la sortie lorsque l'option TIMESTAMP est activée.

Les noms de blocs suivants sont définis en fonction du fait que la balise possède ou non une valeur dans le fichier de configuration utilisé :

LATEX_FONTENC

Le contenu de ce bloc est copié vers la sortie lorsque la fonction de traduction Doxygen latex renvoie une valeur pour l'encodage de police à utiliser. Il doit être utilisé en combinaison avec le $latexfontenc mentionné ci-dessus.

FORMULA_MACROFILE

Le contenu de ce bloc est copié vers la sortie lorsque l'option FORMULA_MACROFILE n'est pas vide. Il doit être utilisé en combinaison avec le $formulamacrofile mentionné ci-dessus.

Le nom de bloc suivant est défini en fonction de l'utilisation ou non d'une fonctionnalité dans la documentation :

CITATIONS_PRESENT

Le contenu de ce bloc est copié dans la sortie lorsque des citations sont présentes dans la documentation et que les .. pertinents sont présents. Il doit être utilisé en combinaison avec les $latexcitereference, $latexbibstyle et $latexbibfiles mentionnés ci-dessus.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_FOOTER

La balise LATEX_FOOTER peut être utilisée pour spécifier un pied de page latex défini par l'utilisateur pour le document latex généré. Le pied de page doit contenir tout ce qui se trouve après le dernier chapitre. S'il est laissé vide, Doxygen générera un pied de page standard.

Voir LATEX_HEADER pour plus d'informations sur la façon de générer un pied de page par défaut et sur les commandes spéciales qui peuvent être utilisées dans le pied de page.

Voir aussi la section Utilisation de Doxygen pour plus d'informations sur la façon de générer le pied de page par défaut que Doxygen utilise normalement.

Remarque : utilisez uniquement un pied de page défini par l'utilisateur si vous savez ce que vous faites !

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_EXTRA_STYLESHEET

La balise LATEX_EXTRA_STYLESHEET peut être utilisée pour spécifier des feuilles de style supplémentaires définies par l'utilisateur latex qui sont incluses après les feuilles de style standard créées par Doxygen. En utilisant cette option, il est possible d'annuler certains aspects du style. Doxygen copiera les fichiers de feuilles de style dans le répertoire de sortie.

Note
L'ordre des fichiers de feuille de style supplémentaires est important (par exemple, la dernière feuille de style de la liste remplace le réglage des précédentes dans la liste).

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_EXTRA_FILES

La balise LATEX_EXTRA_FILES peut être utilisée pour spécifier une ou plusieurs images supplémentaires ou d'autres fichiers sources qui doivent être copiés dans le répertoire de sortie LATEX_OUTPUT. Notez que les fichiers seront copiés tels quels ; aucune commande ni marqueur n'est disponible.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

PDF_HYPERLINKS

Si la balise PDF_HYPERLINKS est définie sur YES, le latex généré est préparé pour la conversion en PDF (en utilisant ps2pdf ou pdflatex). Le fichier PDF contiendra des liens (tout comme la sortie HTML) au lieu de références de page. Cela rend la sortie adaptée à la navigation en ligne à l'aide d'un visualiseur PDF.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

USE_PDFLATEX

Si la balise USE_PDFLATEX est définie sur YES, Doxygen utilisera le moteur tel que spécifié avec LATEX_CMD_NAME pour générer le fichier PDF directement à partir des fichiers latex. Définissez cette option sur YES pour obtenir une documentation PDF de meilleure qualité. Voir également la section LATEX_CMD_NAME pour sélectionner le moteur.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_BATCHMODE

La balise LATEX_BATCHMODE signale le comportement de latexen cas d'erreur.

Les valeurs possibles sont : NO identique à ERROR_STOP, YES identique à BATCH, BATCH en mode batch, rien n'est imprimé sur le terminal, les erreurs défilent comme si <return> était tapé à chaque erreur ; les fichiers manquants que tex tente de saisir ou de demander au clavier (lecture sur un flux d'entrée non ouvert) entraînent l'abandon du travail, NON_STOP en mode non stop, le message de diagnostic apparaît sur le terminal, mais il n'y a pas de possibilité d'interaction avec l'utilisateur, comme en mode batch, SCROLL en mode défilement, tex ne s'arrête que pour les fichiers manquants à saisir ou si une saisie au clavier est nécessaire et ERROR_STOP en mode arrêt sur erreur, tex s'arrête à chaque erreur, en demandant l'intervention de l'utilisateur.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_HIDE_INDICES

Si la balise LATEX_HIDE_INDICES est définie sur YES, Doxygen n'inclura pas les chapitres d'index (tels que l'index des fichiers, l'index composé, etc.) dans la sortie.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_BIB_STYLE

La balise LATEX_BIB_STYLE peut être utilisée pour spécifier le style à utiliser pour la bibliographie, par exemple plainnat ou ieeetr. Voir https://en.wikipedia.org/wiki/BibTeX et \cite pour plus d'informations.

La valeur par défaut est : plainnat.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

LATEX_EMOJI_DIRECTORY

La balise LATEX_EMOJI_DIRECTORY est utilisée pour spécifier le chemin (relatif ou absolu) à partir duquel les images emoji seront lues. Si un chemin relatif est saisi, il sera relatif au répertoire LATEX_OUTPUT. S'il est laissé vide, le répertoire LATEX_OUTPUT sera utilisé.

Cette balise nécessite que la balise GENERATE_LATEX soit définie sur YES.

Options de configuration liées à la sortie RTF

GENERATE_RTF

Si la balise GENERATE_RTF est définie sur YES, Doxygen générera une sortie RTF. La sortie RTF est optimisée pour Word 97 et peut ne pas être très jolie avec d'autres lecteurs/éditeurs RTF.

La valeur par défaut est : NO.

RTF_OUTPUT

La balise RTF_OUTPUT est utilisée pour spécifier où les documents RTF seront placés. Si un chemin relatif est saisi, la valeur de OUTPUT_DIRECTORY sera placée devant lui.

Le répertoire par défaut est : rtf.

Cette balise nécessite que la balise GENERATE_RTF soit définie sur YES.

COMPACT_RTF

Si la balise COMPACT_RTF est définie sur YES, Doxygen génère des documents RTF plus compacts. Cela peut être utile pour les petits projets et peut aider à sauver certaines arborescences en général.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_RTF soit définie sur YES.

RTF_HYPERLINKS

Si la balise RTF_HYPERLINKS est définie sur YES, le RTF généré contiendra des champs d'hyperlien. Le fichier RTF contiendra des liens (tout comme la sortie HTML) au lieu de références de page. Cela rend la sortie adaptée à la navigation en ligne à l'aide de Word ou d'autres lecteurs compatibles Word qui prennent en charge ces champs.

Remarque : WordPad (écriture) et d'autres ne prennent pas en charge les liens.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_RTF soit définie sur YES.

RTF_STYLESHEET_FILE

Chargez les définitions de feuille de style à partir d'un fichier. La syntaxe est similaire à celle du fichier de configuration de Doxygen, c'est-à-dire une série d'affectations. Vous n'avez qu'à fournir des remplacements, les définitions manquantes sont définies sur leur valeur par défaut. Voir également la section Utilisation de Doxygen pour plus d'informations sur la manière de générer la feuille de style par défaut que Doxygen utilise normalement.

Cette balise nécessite que la balise GENERATE_RTF soit définie sur YES.

RTF_EXTENSIONS_FILE

Définissez les variables facultatives utilisées dans la génération d'un document RTF. La syntaxe est similaire au fichier de configuration de Doxygen. Un fichier d'extensions de modèle peut être généré à l'aide de doxygen -e rtf extensionFile.

Cette balise nécessite que la balise GENERATE_RTF soit définie sur YES.

RTF_EXTRA_FILES

La balise RTF_EXTRA_FILES permet de spécifier une ou plusieurs images supplémentaires ou d'autres fichiers sources à copier dans le répertoire de sortie RTF_OUTPUT. Notez que les fichiers seront copiés tels quels ; aucune commande ni marqueur n'est disponible.

Cette balise nécessite que la balise GENERATE_RTF soit définie sur YES.

Options de configuration relatives à la sortie des pages de manuel

GENERATE_MAN

Si la balise GENERATE_MAN est définie sur YES, Doxygen génère les pages de manuel pour les classes et les fichiers.

La valeur par défaut est : NO.

MAN_OUTPUT

La balise MAN_OUTPUT permet de spécifier l'emplacement des pages de manuel. Si un chemin relatif est saisi, la valeur OUTPUT_DIRECTORY le précède. Un répertoire man3 est créé dans le répertoire spécifié par MAN_OUTPUT.

Le répertoire par défaut est : man.

Cette balise nécessite que la balise GENERATE_MAN soit définie sur YES.

MAN_EXTENSION

La balise MAN_EXTENSION détermine l'extension ajoutée aux pages de manuel générées. Si la section du manuel ne commence pas par un chiffre, le chiffre 3 est ajouté au début. Le point (.) au début de la balise MAN_EXTENSION est facultatif.

La valeur par défaut est : .3.

Cette balise nécessite que la balise GENERATE_MAN soit définie sur YES.

MAN_SUBDIR

La balise MAN_SUBDIR détermine le nom du répertoire créé dans MAN_OUTPUT où sont placées les pages de manuel. La valeur par défaut est man suivi de MAN_EXTENSION, le . initial étant supprimé.

Cette balise nécessite que la balise GENERATE_MAN soit définie sur YES.

MAN_LINKS

Si la balise MAN_LINKS est définie sur YES et que Doxygen génère une sortie man, un fichier man supplémentaire sera généré pour chaque entité documentée dans la ou les pages de manuel réelles. Ces fichiers supplémentaires ne contiennent que la page de manuel réelle, mais sans eux, la commande man ne pourrait pas trouver la page correcte.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_MAN soit définie sur YES.

Options de configuration liées à la sortie XML

GENERATE_XML

Si la balise GENERATE_XML est définie sur YES, Doxygen génère un fichier XML qui capture la structure du code, y compris toute la documentation.

La valeur par défaut est : NO.

XML_OUTPUT

La balise XML_OUTPUT permet de spécifier l'emplacement des pages XML. Si un chemin relatif est saisi, la valeur OUTPUT_DIRECTORY sera placée devant.

Le répertoire par défaut est : xml.

Cette balise nécessite que la balise GENERATE_XML soit définie sur YES.

XML_PROGRAMLISTING

Si la balise XML_PROGRAMLISTING est définie sur YES, Doxygen transfère les listes de programmes (y compris la coloration syntaxique et les informations de références croisées) vers la sortie XML. Notez que l'activation de cette option augmente considérablement la taille de la sortie XML.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_XML soit définie sur YES.

XML_NS_MEMB_FILE_SCOPE

Si la balise XML_NS_MEMB_FILE_SCOPE est définie sur YES, Doxygen inclura également les membres de l'espace de noms dans la portée du fichier, conformément à la sortie HTML.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_XML soit définie sur YES.

Options de configuration relatives à la sortie DOCBOOK

GENERATE_DOCBOOK

Si la balise GENERATE_DOCBOOK est définie sur YES, Doxygen génère des fichiers Docbook utilisables pour générer des PDF.

La valeur par défaut est : NO.

DOCBOOK_OUTPUT

La balise DOCBOOK_OUTPUT permet de spécifier l'emplacement des pages Docbook. Si un chemin relatif est saisi, la valeur OUTPUT_DIRECTORY le précède.

Le répertoire par défaut est : docbook.

Cette balise nécessite que la balise GENERATE_DOCBOOK soit définie sur YES.

Options de configuration pour la sortie des définitions AutoGen

GENERATE_AUTOGEN_DEF

Si la balise GENERATE_AUTOGEN_DEF est définie sur YES, Doxygen génère un fichier de définitions AutoGen (voir https://autogen.sourceforge.net/) qui capture la structure du code, y compris toute la documentation. Veuillez noter que cette fonctionnalité est encore expérimentale et incomplète pour le moment.

La valeur par défaut est : NO.

Options de configuration relatives à la sortie SQLite3

GENERATE_SQLITE3

Si la balise GENERATE_SQLITE3 est définie sur YES, Doxygen génère une base de données SQLite3 avec les symboles trouvés par Doxygen stockés dans des tables.

La valeur par défaut est : NO.

SQLITE3_OUTPUT

La balise SQLITE3_OUTPUT permet de spécifier l'emplacement de la base de données SQLite3. Si un chemin relatif est saisi, la valeur OUTPUT_DIRECTORY le précède.

Le répertoire par défaut est : SQLite3.

Cette balise nécessite que la balise GENERATE_SQLITE3 soit définie sur YES.

SQLITE3_RECREATE_DB

Si la balise SQLITE3_RECREATE_DB est définie sur YES, le fichier de base de données doxygen_sqlite3.db existant est recréé à chaque exécution de Doxygen. Si cette option est définie sur NO, Doxygen avertira si un fichier de base de données est déjà trouvé et ne le modifiera pas.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_SQLITE3 soit définie sur YES.

Options de configuration relatives à la sortie du module Perl

GENERATE_PERLMOD

Si la balise GENERATE_PERLMOD est définie sur YES, Doxygen génère un fichier de module Perl qui capture la structure du code, y compris toute la documentation. Notez que cette fonctionnalité est encore expérimentale et incomplète pour le moment.

La valeur par défaut est : NO.

PERLMOD_LATEX

Si la balise PERLMOD_LATEX est définie sur YES, Doxygen génère les règles Makefile, les scripts Perl et le code latex nécessaires pour générer des sorties PDF et DVI à partir de la sortie du module Perl.

La valeur par défaut est : NO.

Cette balise nécessite que la balise GENERATE_PERLMOD soit définie sur YES.

PERLMOD_PRETTY

Si la balise PERLMOD_PRETTY est définie sur YES, la sortie du module Perl sera correctement formatée pour être analysée par un humain. Ceci est utile pour comprendre ce qui se passe. En revanche, si cette balise est définie sur NO, la taille de la sortie du module Perl sera bien plus petite et Perl l'analysera tout de même.

La valeur par défaut est : YES.

Cette balise nécessite que la balise GENERATE_PERLMOD soit définie sur YES.

PERLMOD_MAKEVAR_PREFIX

Les noms des variables make dans le fichier doxyrules.make généré sont préfixés par la chaîne contenue dans PERLMOD_MAKEVAR_PREFIX. Ceci est utile pour éviter que les différents fichiers doxyrules.make inclus dans le même Makefile n'écrasent leurs variables respectives.

Cette balise nécessite que la balise GENERATE_PERLMOD soit définie sur YES.

Options de configuration liées au préprocesseur

ENABLE_PREPROCESSING

Si la balise ENABLE_PREPROCESSING est définie sur YES, Doxygen évaluera toutes les directives du préprocesseur C présentes dans les sources et les fichiers include.

La valeur par défaut est : YES.

MACRO_EXPANSION

Si la balise MACRO_EXPANSION est définie sur YES, Doxygen développera tous les noms de macros du code source. Si elle est définie sur NO, seule la compilation conditionnelle sera effectuée. L'expansion des macros peut être contrôlée en définissant EXPAND_ONLY_PREDEF sur YES.

La valeur par défaut est : NO.

Cette balise nécessite que la balise ENABLE_PREPROCESSING soit définie sur YES.

EXPAND_ONLY_PREDEF

Si les balises EXPAND_ONLY_PREDEF et MACRO_EXPANSION sont toutes deux définies sur YES, l'expansion des macros est limitée aux macros spécifiées par les balises PREDEFINED et EXPAND_AS_DEFINED.

La valeur par défaut est : NO.

Cette balise nécessite que la balise ENABLE_PREPROCESSING soit définie sur YES.

SEARCH_INCLUDES

Si la balise SEARCH_INCLUDES est définie sur YES, les fichiers d'inclusion de INCLUDE_PATH seront recherchés si un #include est trouvé.

La valeur par défaut est : YES.

Cette balise nécessite que la balise ENABLE_PREPROCESSING soit définie sur YES.

INCLUDE_PATH

La balise INCLUDE_PATH permet de spécifier un ou plusieurs répertoires contenant des fichiers d'inclusion qui ne sont pas des fichiers d'entrée, mais qui doivent être traités par le préprocesseur.

Notez que la balise INCLUDE_PATH n'est pas récursive ; le paramètre RECURSIVE n'a donc aucun effet ici.

Cette balise nécessite que la balise SEARCH_INCLUDES soit définie sur YES.

INCLUDE_FILE_PATTERNS

Vous pouvez utiliser la balise INCLUDE_FILE_PATTERNS pour spécifier un ou plusieurs modèles génériques (tels que *.h et *.hpp) afin de filtrer les fichiers d'en-tête des répertoires. Si elle est vide, les modèles spécifiés par FILE_PATTERNS seront utilisés.

Cette balise nécessite que la balise ENABLE_PREPROCESSING soit définie sur YES.

PREDEFINED

La balise PREDEFINED permet de spécifier un ou plusieurs noms de macros définis avant le démarrage du préprocesseur (similaire à l'option -D de gcc, par exemple). L'argument de la balise est une liste de macros au format : nom ou nom=définition (sans espace). Si la définition et le signe « = » sont omis, la valeur « =1 » est supposée. Pour éviter qu'une définition de macro ne soit indéfinie via #undef ou développée récursivement, utilisez l'opérateur := au lieu de l'opérateur =.

Cette balise nécessite que la balise ENABLE_PREPROCESSING soit définie sur YES.

EXPAND_AS_DEFINED

Si les balises MACRO_EXPANSION et EXPAND_ONLY_PREDEF sont définies sur YES, cette balise permet de spécifier une liste de noms de macros à développer. La définition de macro trouvée dans les sources sera utilisée. Utilisez la balise PREDEFINED si vous souhaitez utiliser une définition de macro différente qui remplace celle trouvée dans le code source.

Cette balise nécessite que la balise ENABLE_PREPROCESSING soit définie sur YES.

SKIP_FUNCTION_MACROS

Si la balise SKIP_FUNCTION_MACROS est définie sur YES, le préprocesseur Doxygen supprimera toutes les références aux macros de type fonction qui sont seules sur une ligne, dont le nom est en majuscules et ne se termine pas par un point-virgule. Ces macros de fonction sont généralement utilisées pour du code standard et peuvent perturber l'analyseur si elles ne sont pas supprimées.

La valeur par défaut est : YES.

Cette balise nécessite que la balise ENABLE_PREPROCESSING soit définie sur YES.

Options de configuration relatives aux références externes

TAGFILES

La balise TAGFILES permet de spécifier un ou plusieurs fichiers de balises.

Pour chaque fichier de balises, l'emplacement de la documentation externe doit être indiqué. Le format d'un fichier de balises sans cet emplacement est le suivant :

TAGFILES = fichier1 fichier2 ...

L'ajout d'un emplacement pour les fichiers de balises s'effectue comme suit :

TAGFILES = fichier1=loc1 "fichier2 = loc2" ...

où loc1 et loc2 peuvent être des chemins ou des URL relatifs ou absolus. Consultez la section Liens vers la documentation externe pour plus d'informations sur l'utilisation des fichiers de balises.

Note :
Chaque fichier de balises doit avoir un nom unique (le nom n'incluant pas le chemin). Si un fichier de balises ne se trouve pas dans le répertoire d'exécution de Doxygen, vous devez également spécifier son chemin ici.

GENERATE_TAGFILE

Lorsqu'un nom de fichier est spécifié aprèsGENERATE_TAGFILE, Doxygen crée un fichier de balises basé sur les fichiers d'entrée lus. Consultez la section Liens vers la documentation externe pour plus d'informations sur l'utilisation des fichiers de balises.

ALLEXTERNALS

Si la balise ALLEXTERNALS est définie sur YES, toutes les classes et tous les espaces de noms externes sont répertoriés dans l'index de classe et d'espace de noms. Si la valeur est NO, seules les classes externes héritées sont répertoriées.

La valeur par défaut est : NO.

EXTERNAL_GROUPS

Si la balise EXTERNAL_GROUPS a la valeur YES, tous les groupes externes sont répertoriés dans l'index de rubrique. Si la valeur est NO, seuls les groupes du projet en cours sont répertoriés.

La valeur par défaut est : YES.

EXTERNAL_PAGES

Si la balise EXTERNAL_PAGES est définie sur YES, toutes les pages externes sont répertoriées dans l'index des pages associées. Si la valeur est NO, seules les pages du projet en cours sont répertoriées.

La valeur par défaut est : YES.

Options de configuration relatives aux outils du générateur de diagrammes

HIDE_UNDOC_RELATIONS

Si la valeur est YES, les graphiques d'héritage et de collaboration masquent les relations d'héritage et d'utilisation si la cible n'est pas documentée ou n'est pas une classe.

La valeur par défaut est : YES.

HAVE_DOT

Si vous attribuez la valeur YES à la balise HAVE_DOT, l'outil point est supposé disponible à partir du path. Cet outil fait partie de Graphviz, une boîte à outils de visualisation de graphiques d'AT&T et de Lucent Bell Labs. Les autres options de cette section n'ont aucun effet si cette option est définie sur NO.

La valeur par défaut est : NO.

DOT_NUM_THREADS

Le paramètre DOT_NUM_THREADS spécifie le nombre d'appels de points que Doxygen est autorisé à exécuter en parallèle. Lorsqu'il est défini sur 0, Doxygen se base sur le nombre de processeurs disponibles dans le système. Vous pouvez la définir explicitement sur une valeur supérieure à 0 pour contrôler l'équilibre entre la charge du processeur et la vitesse de traitement.

Valeur minimale : 0, valeur maximale : 32, valeur par défaut : 0.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DOT_COMMON_ATTR

DOT_COMMON_ATTR est un attribut commun pour les nœuds, les arêtes et les libellés des sous-graphes. Lorsque vous souhaitez modifier l'aspect de la police dans les fichiers de points générés par Doxygen, vous pouvez spécifier les attributs fontname, fontcolor et fontsize. Pour plus d'informations, voir Spécification des attributs de nœud, d'arête et de graphique. Vous devez vous assurer que dot est capable de trouver la police, ce qui peut être fait en la plaçant dans un emplacement standard ou en définissant la variable d'environnement DOTFONTPATH ou en définissant DOT_FONTPATH sur le répertoire contenant la police. La taille par défaut de la police graphviz est 14.

La valeur par défaut est : fontname=Helvetica, fontsize=10.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DOT_EDGE_ATTR

DOT_EDGE_ATTR est concaténé avec DOT_COMMON_ATTR. Pour un style élégant, vous pouvez ajouter 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Documentation complète sur les formes de flèches.

La valeur par défaut est : labelfontname=Helvetica, labelfontsize=10.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DOT_NODE_ATTR

DOT_NODE_ATTR est concaténé avec DOT_COMMON_ATTR. Pour l'affichage sans zones autour des nœuds, définissez 'shape=plain' ou 'shape=plaintext' Spécification des formes

La valeur par défaut est : shape=box, height=0.2, width=0.4.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DOT_FONTPATH

Vous pouvez définir le chemin où dot peut trouver la police spécifiée avec fontname dans DOT_COMMON_ATTR et d'autres attributs de point.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

CLASS_GRAPH

Si la balise CLASS_GRAPH est définie sur YES ou GRAPH ou BUILTIN, Doxygen génère un graphique pour chaque classe documentée indiquant les relations d'héritage directes et indirectes. Si la balise CLASS_GRAPH est définie sur YES ou GRAPH et que HAVE_DOT est également activé, le point sera utilisé pour dessiner le graphique. Si la balise CLASS_GRAPH est définie sur YES et que HAVE_DOT est désactivé ou si la balise CLASS_GRAPH est définie sur BUILTIN, le générateur intégré sera utilisé. Si la balise CLASS_GRAPH est définie sur TEXT, les relations d'héritage directes et indirectes seront affichées sous forme de textes / liens. L'activation explicite d'un graphique d'héritage ou le choix d'une représentation différente pour un graphique d'héritage d'une classe spécifique peut être effectuée à l'aide de la commande \inheritancegraph. La désactivation d'un graphe d'héritage peut être effectuée à l'aide de la commande \hideinheritancegraph.

Les valeurs possibles sont : NO, YES, TEXT, GRAPH et BUILTIN.

La valeur par défaut est : YES.

COLLABORATION_GRAPH

Si la balise COLLABORATION_GRAPH est définie sur YES, Doxygen génère un graphique pour chaque classe documentée indiquant les dépendances d'implémentation directes et indirectes (variables d'héritage, de contenance et de références de classe) de la classe avec les autres classes documentées. L'activation explicite d'un graphe de collaboration, lorsque COLLABORATION_GRAPH est défini sur NO, peut être effectuée à l'aide de la commande \collaborationgraph. La désactivation d'un graphique de collaboration peut être effectuée à l'aide de la commande \hidecollaborationgraph.

La valeur par défaut est : YES.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

GROUP_GRAPHS

Si la balise GROUP_GRAPHS est définie sur YES, Doxygen génère un graphique pour les groupes, indiquant les dépendances directes des groupes. L'activation explicite d'un graphique de dépendance de groupe, lorsque GROUP_GRAPHS est défini sur NO, peut être effectuée à l'aide de la commande \groupgraph. La désactivation d'un graphe de répertoire peut être effectuée à l'aide de la commande **\hidegroupgraph**.

Reportez-vous également au chapitre Regroupement du manuel.

La valeur par défaut est : YES.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

UML_LOOK

Si la balise UML_LOOK est définie sur YES, Doxygen générera des diagrammes d'héritage et de collaboration dans un style similaire au langage de modélisation unifié de l'OMG.

La valeur par défaut est : NO.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

UML_LIMIT_NUM_FIELDS

Si la balise UML_LOOK est activée, les champs et les méthodes sont affichés à l'intérieur du nœud de classe. S'il existe de nombreux champs ou méthodes et de nombreux nœuds, le graphique peut devenir trop volumineux pour être utile. Le seuil UML_LIMIT_NUM_FIELDS limite le nombre d'éléments pour chaque type afin de rendre la taille plus gérable. Définissez cette valeur sur 0 sans limite. Notez que le seuil peut être dépassé de 50% avant que la limite ne soit appliquée. Ainsi, lorsque vous définissez le seuil sur 10, jusqu'à 15 champs peuvent apparaître, mais si le nombre dépasse 15, le nombre total de champs affichés est limité à 10.

Valeur minimale : 0, valeur maximale : 100, valeur par défaut : 10.

Cette balise nécessite que la balise UML_LOOK soit définie sur YES.

UML_MAX_EDGE_LABELS

Si la balise UML_LOOK est activée, les étiquettes de champ sont affichées le long de l'arête entre deux nœuds de classe. S'il y a beaucoup de champs et de nœuds, le graphique peut devenir trop encombré. Le seuil UML_MAX_EDGE_LABELS limite le nombre d'éléments pour rendre la taille plus gérable. Définissez cette valeur sur 0 sans limite.

Valeur minimale : 0, valeur maximale : 100, valeur par défaut : 10.

Cette balise nécessite que la balise UML_LOOK soit définie sur YES.

DOT_UML_DETAILS

Si la balise DOT_UML_DETAILS est définie sur NO, Doxygen affichera les attributs et les méthodes sans type ni argument dans les graphiques UML. Si la balise DOT_UML_DETAILS est définie sur YES, Doxygen ajoute le type et les arguments des attributs et des méthodes dans les graphiques UML. Si la balise DOT_UML_DETAILS est définie sur NONE, Doxygen ne génère pas de champs contenant des informations sur les membres de classe dans les graphiques UML. Les diagrammes de classes ressembleront aux diagrammes de classes par défaut, mais en utilisant la notation UML pour les relations.

Les valeurs possibles sont : NO, YES et NONE.

La valeur par défaut est : NO.

Cette balise nécessite que la balise UML_LOOK soit définie sur YES.

DOT_WRAP_THRESHOLD

La balise DOT_WRAP_THRESHOLD permet de définir le nombre maximal de caractères à afficher sur une seule ligne. Si la longueur réelle de la ligne dépasse ce seuil de manière significative, elle est renvoyée à la ligne sur plusieurs lignes. Certaines heuristiques sont appliquées pour éviter les sauts de ligne indésirables.

Valeur minimale : 0, valeur maximale : 1000, valeur par défaut : 17.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

TEMPLATE_RELATIONS

Si la balise TEMPLATE_RELATIONS est définie sur YES, les graphiques d'héritage et de collaboration afficheront les relations entre les modèles et leurs instances.

La valeur par défaut est : NO.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

INCLUDE_GRAPH

Si les balises INCLUDE_GRAPH, ENABLE_PREPROCESSING et EARCH_INCLUDE sont définies sur YES, Doxygen génère un graphique pour chaque fichier documenté indiquant les dépendances d'inclusion directes et indirectes du fichier avec d'autres fichiers documentés. L'activation explicite d'un graphe d'inclusion, lorsque INCLUDE_GRAPH est défini sur NO, peut être effectuée à l'aide de la commande \includegraph. La désactivation d'un graphe include peut être effectuée à l'aide de la commande \hideincludegraph.

La valeur par défaut est : YES.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

INCLUDED_BY_GRAPH

Si les balises INCLUDE_BY_GRAPH, ENABLE_PREPROCESSING et SEARCH_INCLUDE sont définies sur YES, Doxygen génère un graphique pour chaque fichier documenté indiquant les dépendances d'inclusion directes et indirectes du fichier avec d'autres fichiers documentés. L'activation explicite d'un graphe inclus par, lorsque INCLUDE_BY_GRAPH est défini sur NO, peut être effectuée à l'aide de la commande \includedbygraph. La désactivation d'un graphe inclus par peut être effectuée à l'aide de la commande \hideincludedbygraph.

La valeur par défaut est : YES.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

CALL_GRAPH

Si la balise CALL_GRAPH est définie sur YES, Doxygen générera un graphique de dépendance d'appel pour chaque fonction globale ou méthode de classe. Notez que l'activation de cette option augmente considérablement la durée d'une exécution. Dans la plupart des cas, il est préférable d'activer les graphiques d'appel pour les fonctions sélectionnées uniquement à l'aide de la commande \callgraph. La désactivation d'un graphique d'appel peut être effectuée à l'aide de la commande \hidecallgraph.

La valeur par défaut est : NO.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

CALLER_GRAPH

Si la balise CALLER_GRAPH est définie sur YES, Doxygen générera un graphique de dépendance de l'appelant pour chaque fonction globale ou méthode de classe. Notez que l'activation de cette option augmente considérablement la durée d'une exécution. Dans la plupart des cas, il est préférable d'activer les graphiques de l'appelant pour les fonctions sélectionnées uniquement à l'aide de la commande \callergraph. La désactivation d'un graphique appelant peut être effectuée à l'aide de la commande \hidecallergraph.

La valeur par défaut est : NO.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

GRAPHICAL_HIERARCHY

Si la balise GRAPHICAL_HIERARCHY est définie sur YES, Doxygen affiche la hiérarchie graphique de toutes les classes au lieu d'une hiérarchie textuelle.

La valeur par défaut est : YES.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DIRECTORY_GRAPH

Si la balise DIRECTORY_GRAPH est définie sur YES, Doxygen affichera les dépendances d'un répertoire sur d'autres répertoires de manière graphique. Les relations de dépendance sont déterminées par les relations #include entre les fichiers des répertoires. L'activation explicite d'un graphe de répertoires, lorsque DIRECTORY_GRAPH est défini sur NO, peut être effectuée à l'aide de la commande \directorygraph. La désactivation d'un graphe de répertoires peut être effectuée à l'aide de la commande \hidedirectorygraph.

La valeur par défaut est : YES.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DIR_GRAPH_MAX_DEPTH

La balise DIR_GRAPH_MAX_DEPTH peut être utilisée pour limiter le nombre maximal de niveaux de répertoires enfants générés dans les graphiques de dépendance de répertoires par dot.

Valeur minimale : 1, valeur maximale : 25, valeur par défaut : 1.

Cette balise requiert que la balise DIRECTORY_GRAPH soit définie sur YES.

**DOT_IMAGE_FORMAT **

La balise DOT_IMAGE_FORMAT peut être utilisée pour définir le format d'image des images générées par dot. Pour une explication des formats d'image, voir la section formats de sortie dans la documentation de l'outil point (Graphviz). Notez que les formats svg:cairo et svg:cairo:cairo ne peuvent pas être utilisés en combinaison avec INTERACTIVE_SVG (INTERACTIVE_SVG sera défini sur NO).

Les valeurs possibles sont : png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus, png:gdiplus:gdiplus, svg:cairo, svg:cairo:cairo, svg:svg, svg:svg:core, gif:cairo:gd, gif:cairo:gdiplus, gif:gdiplus, gif:gdiplus:gdiplus, gif:gd, gif:gd:gd, jpg:cairo, jpg:gd, jpg:cairo:gd, jpg:cairo:gdiplus, jpg:gd, jpg:gd:gd, jpg:gdiplus et jpg:gdiplus:gdiplus.

La valeur par défaut est : png.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

INTERACTIVE_SVG

Si DOT_IMAGE_FORMAT est défini sur svg ou svg:svg ou svg:svg:core, cette option peut être définie sur YES pour permettre la génération d'images SVG interactives qui permettent le zoom et le panoramique. Notez que cela nécessite un navigateur moderne autre qu'Internet Explorer. Testés et en cours de fonctionnement sont Firefox, Chrome, Safari et Opera. Remarque Cette option sera automatiquement désactivée lorsque DOT_IMAGE_FORMAT est défini sur svg:cairo ou svg:cairo:cairo.

La valeur par défaut est : NO.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DOT_PATH

La balise DOT_PATH peut être utilisée pour spécifier le chemin où se trouve l'outil point. Si ce champ est vide, l'outil point est supposé se trouver dans le tracé.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DOTFILE_DIRS

La balise DOTFILE_DIRS peut être utilisée pour spécifier un ou plusieurs répertoires contenant des fichiers point inclus dans la documentation (voir la commande \dotfile).

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DIA_PATH

Vous pouvez inclure des diagrammes réalisés avec dia dans la documentation de Doxygen. Doxygen exécutera ensuite dia pour produire le diagramme et l'insérer dans la documentation. La balise DIA_PATH vous permet de spécifier le répertoire dans lequel réside le fichier binaire dia. Si un champ vide est supposé se trouver dans le chemin de recherche par défaut.

DIAFILE_DIRS

La balise DIAFILE_DIRS peut être utilisée pour spécifier un ou plusieurs répertoires contenant des fichiers dia inclus dans la documentation (voir la commande \diafile).

PLANTUML_JAR_PATH

Lors de l'utilisation de PlantUML, la balise PLANTUML_JAR_PATH doit être utilisée pour spécifier le chemin où java peut trouver le fichier plantuml.jar ou le nom de fichier du fichier jar à utiliser. Si ce champ est vide, PlantUML n'est pas utilisé ou appelé lors d'une étape de prétraitement. Dans ce cas, Doxy génère un avertissement lorsqu'il rencontre une commande \startuml et ne génère pas de sortie pour le diagramme.

PLANTUML_CFG_FILE

Lorsque vous utilisez PlantUML, la balise PLANTUML_CFG_FILE peut être utilisée pour spécifier un fichier de configuration pour PlantUML.

PLANTUML_INCLUDE_PATH

Lors de l'utilisation de PlantUML, les chemins spécifiés sont recherchés pour les fichiers spécifiés par l'instruction !include dans un bloc PlantUML.

PLANTUMLFILE_DIRS

La balise PLANTUMLFILE_DIRS peut être utilisée pour spécifier un ou plusieurs répertoires contenant des fichiers PlantUml inclus dans la documentation (voir la commande \plantumlfile).

DOT_GRAPH_MAX_NODES

La balise DOT_GRAPH_MAX_NODES peut être utilisée pour définir le nombre maximal de nœuds qui seront affichés dans le graphique. Si le nombre de nœuds d'un graphique dépasse cette valeur, Doxygen tronque le graphique, ce qui est visualisé en représentant un nœud sous la forme d'une boîte rouge. Notez que si le nombre d'enfants directs du nœud racine dans un graphique est déjà supérieur à DOT_GRAPH_MAX_NODES, le graphique ne sera pas affiché du tout. Notez également que la taille d'un graphique peut être limitée par MAX_DOT_GRAPH_DEPTH.

Valeur minimale : 0, valeur maximale : 10000, valeur par défaut : 50.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

MAX_DOT_GRAPH_DEPTH

La balise MAX_DOT_GRAPH_DEPTH permet de définir la profondeur maximale des graphiques générés par dot. Une valeur de profondeur de 3 signifie que seuls les nœuds accessibles à partir de la racine en suivant un chemin via au plus 3 arêtes seront affichés. Les nœuds situés plus loin du nœud racine seront omis. Notez que l'attribution de la valeur 1 ou 2 à cette option peut réduire considérablement le temps de calcul nécessaire pour les bases de code volumineuses. Notez également que la taille d'un graphique peut être davantage limitée par DOT_GRAPH_MAX_NODES. L'utilisation d'une profondeur de 0 ne signifie aucune restriction de profondeur.

Valeur minimale : 0, valeur maximale : 1000, valeur par défaut : 0.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DOT_MULTI_TARGETS

Définissez la balise DOT_MULTI_TARGETS sur YES pour permettre à dot de générer plusieurs fichiers de sortie en une seule exécution (c'est-à-dire plusieurs options -o et -T sur la ligne de commande). Cela rend l'exécution de dot plus rapide, mais comme seules les versions plus récentes de dot (>1.8.10) prennent en charge cette fonctionnalité est désactivée par défaut.

La valeur par défaut est : NO.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

GENERATE_LEGEND

Si la balise GENERATE_LEGEND est définie sur YES, Doxygen génère une page de légende expliquant la signification des différentes cases et flèches dans les graphiques générés par points.

Note
Cette balise nécessite qu'UML_LOOK ne soit pas défini, c'est-à-dire que la représentation graphique interne de Doxygen pour les diagrammes d'héritage et de collaboration est utilisée.

La valeur par défaut est : YES.

Cette balise nécessite que la balise HAVE_DOT soit définie sur YES.

DOT_CLEANUP

Si la balise DOT_CLEANUP est définie sur YES, Doxygen supprime les fichiers intermédiaires utilisés pour générer les différents graphes. Remarque : ce paramètre n'est pas seulement utilisé pour les fichiers point, mais aussi pour les fichiers temporaires msc.

La valeur par défaut est : YES.

MSCGEN_TOOL

La commande \msc permet de définir des graphiques de séquence de messages dans les commentaires Doxygen. Si la balise MSCGEN_TOOL est laissée vide (valeur par défaut), Doxygen utilisera une version intégrée de l'outil mscgen pour produire les graphiques. La balise MSCGEN_TOOL peut également spécifier le nom d'un outil externe. Par exemple, si vous spécifiez prog comme valeur, Doxygen appellera l'outil prog -T <format_fichier_sortie> -o <fichier_sortie> <fichier d'entrée>. L'outil externe doit prendre en charge les formats de fichier de sortie « png », « eps », « svg » et « ismap ».

MSCFILE_DIRS

La balise MSCFILE_DIRS peut être utilisée pour spécifier un ou plusieurs répertoires contenant des fichiers msc inclus dans la documentation (voir la commande \mscfile).

Exemples

Supposons que vous ayez un projet simple composé de deux fichiers : un fichier source example.cc et un fichier d'en-tête example.h. Un fichier de configuration minimal est aussi simple que :

INPUT            = example.cc example.h

En supposant que l'exemple utilise des classes QT et Perl se trouve dans /usr/bin, un fichier de configuration plus réaliste serait:

PROJECT_NAME     = Example
INPUT            = example.cc example.h
WARNINGS         = YES
TAGFILES         = qt.tag
SEARCHENGINE     = NO

Pour générer la documentation du package QdbtTabular, j'ai utilisé le fichier de configuration suivant:

PROJECT_NAME     = QdbtTabular
OUTPUT_DIRECTORY = html
WARNINGS         = YES
INPUT            = examples/examples.doc src
FILE_PATTERNS    = *.cc *.h
INCLUDE_PATH     = examples
TAGFILES         = qt.tag
SEARCHENGINE     = YES

Pour régénérer la documentation QT-1.44 à partir des sources, vous pouvez utiliser le fichier de configuration suivant:

PROJECT_NAME         = Qt
OUTPUT_DIRECTORY     = qt_docs
HIDE_UNDOC_MEMBERS   = YES
HIDE_UNDOC_CLASSES   = YES
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION      = YES
EXPAND_ONLY_PREDEF   = YES
SEARCH_INCLUDES      = YES
FULL_PATH_NAMES      = YES
STRIP_FROM_PATH      = $(QTDIR)/
PREDEFINED           = USE_TEMPLATECLASS Q_EXPORT= \
                       QArrayT:=QArray \
                       QListT:=QList \
                       QDictT:=QDict \
                       QQueueT:=QQueue \
                       QVectorT:=QVector \
                       QPtrDictT:=QPtrDict \
                       QIntDictT:=QIntDict \
                       QStackT:=QStack \
                       QDictIteratorT:=QDictIterator \
                       QListIteratorT:=QListIterator \
                       QCacheT:=QCache \
                       QCacheIteratorT:=QCacheIterator \
                       QIntCacheT:=QIntCache \
                       QIntCacheIteratorT:=QIntCacheIterator \
                       QIntDictIteratorT:=QIntDictIterator \
                       QPtrDictIteratorT:=QPtrDictIterator
INPUT                = $(QTDIR)/doc \
                       $(QTDIR)/src/widgets \
                       $(QTDIR)/src/kernel \
                       $(QTDIR)/src/dialogs \
                       $(QTDIR)/src/tools
FILE_PATTERNS        = *.cpp *.h q*.doc
INCLUDE_PATH         = $(QTDIR)/include
RECURSIVE            = YES

For the Qt-2.1 sources I recommend to use the following settings:

PROJECT_NAME          = Qt
PROJECT_NUMBER        = 2.1
HIDE_UNDOC_MEMBERS    = YES
HIDE_UNDOC_CLASSES    = YES
SOURCE_BROWSER        = YES
INPUT                 = $(QTDIR)/src
FILE_PATTERNS         = *.cpp *.h q*.doc
RECURSIVE             = YES
EXCLUDE_PATTERNS      = *codec.cpp moc_* */compat/* */3rdparty/*
ALPHABETICAL_INDEX    = YES
IGNORE_PREFIX         = Q
ENABLE_PREPROCESSING  = YES
MACRO_EXPANSION       = YES
INCLUDE_PATH          = $(QTDIR)/include
PREDEFINED            = Q_PROPERTY(x)= \
                        Q_OVERRIDE(x)= \
                        Q_EXPORT= \
                        Q_ENUMS(x)= \
                        "QT_STATIC_CONST=static const " \
                        _WS_X11_ \
                        INCLUDE_MENUITEM_DEF
EXPAND_ONLY_PREDEF    = YES
EXPAND_AS_DEFINED     = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \
                        Q_VARIANT_AS

Ici, le préprocesseur de Doxygen est utilisé pour remplacer certains noms de macro qui sont normalement substitués par le préprocesseur C, mais sans faire une expansion macro complète.