Macros

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

Les macros sont utiles pour

• Inclure du texte récurrent, tel que des extraits de texte formatés, dans la documentation.
• Intégrer dans la documentation des informations, telles que des chaînes de version, provenant du système de construction.
• Maintenir un emplacement unique pour les chaînes susceptibles de changer à l'avenir, comme les noms de produits.
• S'assurer qu'un terme ou un nom de produit est utilisé de manière cohérente.
• styliser la documentation générée en utilisant des éléments HTML et DocBook, tels que les retours à la ligne forcés et les caractères spéciaux
• Utiliser des onglets pour montrer des exemples de contenu pour différents langages de programmation, systèmes d'exploitation ou outils, par exemple.

Macros globales

Pour un ensemble de macros globales prédéfinies que vous pouvez utiliser dans tous les projets de documentation et leurs valeurs actuelles, voir /qtbase/doc/global/macros.qdocconf et /qtbase/doc/global/htmltabs.qdocconf. Ils ont des macros qui incluent :

• Extraits de texte CMake
• Formatage HTML et DocBook
• Noms de produits
• Versions de produits
• Contenu à onglets
• Liens vers le contenu de YouTube
• Macros diverses

Qt Online Installer copie les fichiers de macros dans votre dossier d'installation de Qt, afin que vous puissiez utiliser les macros même si vous construisez la documentation en utilisant QDoc à partir d'un Qt installé (par opposition à la construction de 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 du projet ou dans tout autre fichier .qdocconf que vous incluez dans le projet. Si la macro peut être utile dans plusieurs projets de documentation, ajoutez-la au fichier global des macros.

Pour plus d'informations sur la syntaxe et les options des macros, voir macro.

Utilisation des macros

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

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

Par exemple, dans les fichiers source de documentation (.qdoc, .qdocinc) :

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

Macros obsolètes

Le fichier global des macros contient les macros obsolètes suivantes pour des raisons de compatibilité avec les anciens jeux de documentation.