Macros

Utilice la variable macro para crear sus propios comandos QDoc simples.

Las macros son útiles para:

• Incluir texto recurrente, como fragmentos de texto formateados, en la documentación.
• Incorporar información, como cadenas de versión, desde el sistema de compilación a la documentación.
• Mantener una única ubicación para las cadenas que probablemente cambien en el futuro, como los nombres de los productos.
• Asegurarse de que un término o nombre de producto se utiliza de forma coherente.
• Estilizar la documentación generada utilizando elementos HTML y DocBook, como saltos de línea forzados y caracteres especiales.
• Utilizando pestañas para mostrar ejemplos de contenido para diferentes lenguajes de programación, sistemas operativos o herramientas, por ejemplo.

Macros globales

Para ver un conjunto de macros globales predefinidas que puede utilizar en todos los proyectos de documentación y sus valores actuales, consulte /qtbase/doc/global/macros .qdocconf y /qtbase/doc/global/htmltabs.qdocconf. Tienen macros que incluyen:

• Fragmentos de texto CMake
• Formato HTML y DocBook
• Nombres de productos
• Versiones de productos
• Contenido en pestañas
• Enlaces a contenidos de YouTube
• Macros varias

Qt Online Installer copia los archivos de macros en la carpeta de instalación de Qt, de forma que pueda utilizar las macros incluso si construye la documentación utilizando QDoc a partir de un Qt instalado (en lugar de construir QDoc usted mismo a partir de las fuentes).

Añadir macros

Puede añadir macros para un proyecto de documentación concreto en el archivo .qdocconf del proyecto o en cualquier archivo .qdocconf que incluya en él. Si la macro puede ser útil en más de un proyecto de documentación, añádala al archivo global de macros.

Para obtener más información sobre la sintaxis y las opciones de las macros, consulte macros.

Utilización de macros

Puede utilizar macros del mismo modo que los comandos incorporados de QDoc en:

• Archivos fuente de código, en comentarios de documentación (.cpp, .qml)
• Archivos fuente de documentación (.qdoc, .qdocinc)

Por ejemplo

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

Macros obsoletas

El archivo de macros globales contiene las siguientes macros obsoletas por compatibilidad con conjuntos de documentación antiguos.