Documentación para comentarios sobre la documentación de Qt? Qt + Doxygen?

Question

¿Dónde puedo encontrar documentación para los comentarios de la documentación de Qt? Me refiero a cómo Qt usa un estilo específico para los comentarios de la documentación, de esta manera:

/*! 
    \class MyClassName 
    \brief The MyClassName class is used as an example on Stack Overflow. 

    This class serves a few functions, the most important being: 

    \list 
     \i So people can understand my question. 
     \i So people can have a few laughs at the comedy in my example. 
    \endlist 
*/ 

... usted se hace una idea. Entonces, ¿dónde puedo encontrar información sobre todos los switches, como \ class, \ list, \ brief, etc. Además, qué herramienta (s) uso para generar archivos de documentación de estos comentarios en mis archivos de origen? ¿Doxygen es compatible con esta sintaxis?

Answer 1

No utilice qdoc. It is deprecated. Use Doxygen, que se basa en qdoc de todos modos.

Dicho esto, la documentación (en formato qdoc :-D) es here.

Answer 2

Puede echar un vistazo al código fuente de Qt en sí para los comentarios de la documentación de Qt ...

Qt - SRC - 4.6.3

he utilizado Doxygen para la documentación y para mí que está funcionando bien, aunque la documentación los estándares no son de Qt. Sin embargo, te sugiero que lo intentes y decidas.

Answer 3

Uso Doxygen para crear documentación

Puede generar un navegador de documentación en línea (en HTML) y/o un manual de referencia fuera de línea (látex) de un conjunto de ficheros fuente documentados. También se admite la generación de resultados en RTF (MS-Word), PostScript, PDF hipervinculado, HTML comprimido y páginas man de Unix. La documentación se extrae directamente de las fuentes, lo que hace que sea mucho más fácil mantener la documentación coherente con el código fuente.

Puede configurar doxygen para extraer la estructura de código de archivos fuente no documentados. Esto es muy útil para encontrar rápidamente su camino en grandes distribuciones de fuentes. También puede visualizar las relaciones entre los diversos elementos mediante gráficos de dependencia, diagramas de herencia y diagramas de colaboración, que se generan automáticamente.

http://www.stack.nl/~dimitri/doxygen/

Answer 4

Hay dos partes de Doxygen que son qt-específica: la comentario a Qt estilo y la etiqueta de configuración doxyfile QT_AUTOBRIEF. Estas son simplemente partes de doxygen que QT usa. Todos los comentarios doxygen utilizados por QT son cosas doxygen regulares. Entonces solo necesitas leer Doxygen.

O tal que realmente busca para la documentación de los componentes internos QT, tales como información sobre D-Punteros que figura en this blog entry

Qt Style Comentarios: El \ *! texto */ estilo de comentario se llama el "Estilo Qt" de los comentarios doxgyen. Los "!" marca el bloque de comentarios completo como un bloque de comentario doxygen. Es una parte estándar y opcional de Doxygen.

entorno QT_AUTOBRIEF: si la etiqueta "QT_AUTOBRIEF" se establece en TRUE en el Doxyfile, la primera línea de un bloque de comentario estilo de Qt es interpretado automáticamente como la breve descripción \.

De la ayuda GUI doygen:

etiqueta QT_AUTOBRIEF se establece en YES entonces Doxygen interpretar la primera línea (hasta el primer punto) de un comentario al estilo de Qt como la breve descripción . Si se establece en NO, los comentarios se comportarán igual regulares comentarios al estilo de Qt (por lo que requiere una breve orden explícita \ para una breve descripción .)