Macros
Utiliza la variable de macro para crear tus propios comandos QDoc sencillos.
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 los archivos .documentation.
- Mantener una única ubicación para las cadenas que probablemente cambien en el futuro, como los nombres de productos.
- Garantizar que un término o nombre de producto se utilice de forma coherente.
- Dar estilo a la documentación generada mediante elementos HTML y DocBook, como saltos de línea forzados y caracteres especiales.
- Utilizar pestañas para mostrar ejemplos de contenido para diferentes lenguajes de programación, sistemas operativos o herramientas, por ejemplo.
Macros globales
Para consultar un conjunto de macros globales predefinidas que puedes utilizar en todos los proyectos de documentación, así como sus valores actuales, consulta /qtbase/doc/global/macros.qdocconf y /qtbase/doc/global/htmltabs.qdocconf. Entre ellas se incluyen las siguientes macros:
- Fragmentos de texto de CMake
- Formato HTML y DocBook
- Nombres de productos
- Versiones de productos
- Contenido en pestañas
- Enlaces a contenido de YouTube
- Macros varias
Qt Online Installer copia los archivos de macros a tu carpeta de instalación de Qt, de modo que puedas utilizar las macros incluso si compilas la documentación con QDoc a partir de una instalación de Qt (en lugar de compilar QDoc tú mismo a partir de los fuentes).
Nota: Los valores de las macros globales pueden variar entre versiones de Qt, por lo que las macros pueden ampliarse de forma diferente en función de la versión de Qt que utilices para generar la documentación.
Añadir macros
Puedes añadir macros para un proyecto de documentación concreto en el archivo .qdocconf del proyecto o en cualquier archivo .qdocconf que incluyas en él. Si la macro pudiera resultar útil en más de un proyecto de documentación, añádela al archivo de macros globales.
Para obtener más información sobre la sintaxis y las opciones de las macros, consulta macro.
Uso de macros
Puedes utilizar las macros del mismo modo que los comandos QDoc integrados 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 para garantizar la compatibilidad con conjuntos de documentación más antiguos.
| No utilizar | Utilice |
|---|---|
| \gui | \uicontrol |
| \menu | \uicontrol |
| \param | \a |
| \return | Escriba «Returns » o «returns». |
Véase también la macro y la macro «Unknown».
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.