Primeros pasos con QDoc

Qt utiliza QDoc para generar su documentación en formatos HTML y DocBook XML. QDoc utiliza un conjunto de archivos de configuración para generar la documentación a partir de los comentarios de QDoc. Los comentarios tienen tipos llamados temas que determinan si un comentario es una documentación de clase o una documentación de propiedad. Un comentario también puede tener marcas para mejorar el diseño y el formato del resultado final.

Hay tres materiales esenciales para generar documentación con QDoc:

• QDoc binario
• qdocconf archivos de configuración
• Documentation en archivos C++, QML, y .qdoc

QDoc necesita Clang para analizar los archivos fuente y de cabecera de C++, y para analizar las firmas de función de los comandos. \fn de los comandos. Ver Instalación de Clang para QDoc para más detalles.

Esta sección pretende cubrir las necesidades básicas para crear un conjunto de documentación. Además, la guía presenta consideraciones especiales y opciones para documentar la documentación de la API que no sea C++, así como la documentación de QML. Por último, la guía proporcionará un ejemplo de documentación de proyecto y un ejemplo de documentación de tipo QML.

Para obtener información específica sobre QDoc, consulte el Manual de QDoc.

Capítulos

1. Instalación de Clang para QDoc
2. Creación de archivos de configuración de QDoc
3. Escribiendo Documentación
4. Categorías de Documentación
   • Estilo de Documentación C
   • Estilo de documentación QML
5. Resolución de problemas con QDoc