Macros

Utilisez la variable macro pour créer vos propres commandes QDoc simples.

Les macros sont utiles pour :

• d'inclure du texte récurrent, tel que des extraits de texte formatés, dans la documentation ;
• Extraire des informations, telles que des chaînes de version, du système de compilation vers le fichier .documentation.
• Conserver un emplacement unique pour les chaînes susceptibles d’évoluer à l’avenir, telles que les noms de produits.
• Garantir l'utilisation cohérente d'un terme ou d'un nom de produit.
• Mettre en forme la documentation générée à l’aide d’éléments HTML et DocBook, tels que les sauts de ligne forcés et les caractères spéciaux.
• Utiliser des onglets pour présenter des exemples de contenu relatifs à différents langages de programmation, systèmes d’exploitation ou outils, par exemple.

Macros globales

Pour consulter un ensemble de macros globales prédéfinies que vous pouvez utiliser dans tous les projets de documentation, ainsi que leurs valeurs actuelles, consultez les fichiers /qtbase/doc/global/macros.qdocconf et /qtbase/doc/global/htmltabs.qdocconf. Ces fichiers contiennent notamment les macros suivantes :

• Extraits de code CMake
• Mise en forme HTML et DocBook
• Noms de produits
• Versions de produits
• Contenu à onglets
• Liens vers du contenu YouTube
• Macros diverses

Qt Online Installer copie les fichiers de macros dans votre dossier d'installation de Qt, ce qui vous permet d'utiliser les macros même si vous générez la documentation à l'aide de QDoc à partir d'une version installée de Qt (plutôt que de compiler QDoc vous-même à partir des sources).

Ajout de macros

Vous pouvez ajouter des macros pour un projet de documentation particulier dans le fichier .qdocconf de ce projet ou dans n’importe quel fichier .qdocconf que vous y incluez. Si la macro peut être utile dans plusieurs projets de documentation, ajoutez-la au fichier de macros globales.

Pour plus d’informations sur la syntaxe et les options des macros, consultez la section macro.

Utilisation des macros

Vous pouvez utiliser les macros de la même manière que les commandes QDoc intégrées dans :

• Fichiers source de code, dans les commentaires de documentation (.cpp, .qml)
• Fichiers source de documentation (.qdoc, .qdocinc)

Par exemple :

\QOI copies the macros files to your Qt installation folder.

Macros obsolètes

Le fichier de macros globales contient les macros obsolètes suivantes, pour des raisons de compatibilité avec les anciens ensembles de documentation.