Primeros pasos con QDoc
Qt utiliza QDoc para generar su documentación en los formatos HTML y DocBook XML. QDoc utiliza un conjunto de archivos de configuración para generar documentación a partir de los comentarios de QDoc. Los comentarios tienen tipos denominados «temas» que determinan si un comentario corresponde a la documentación de una clase o a la de una propiedad. Un comentario también puede incluir marcas de formato para mejorar la disposición y el formato del resultado final.
Hay tres elementos esenciales para generar documentación con QDoc:
QDocarchivos de configuraciónqdocconfarchivos de configuraciónDocumentationen los archivos «C++», «QML» y «.qdoc»
QDoc requiere Clang para analizar los archivos de cabecera y fuente de C++, así como para analizar las firmas de las funciones en los \fn los comandos. Consulta «Instalación de Clang para QDoc» para obtener más detalles.
Esta sección pretende cubrir los requisitos básicos para crear un conjunto de documentación. Además, la guía presenta consideraciones y opciones especiales para documentar API que no sean de C++, así como documentación de QML. Por último, la guía proporcionará un proyecto de documentación de ejemplo y un ejemplo de documentación de un tipo de QML.
Para obtener información específica sobre QDoc, consulta el Manual de QDoc.
Capítulos
© 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.