2011-12-13 19 views
19

Cuando coloca el puntero del mouse sobre cualquier función Qt/clase, muestra una ventana emergente con una breve descripción de lo que hace, tomada de los documentos en el comentario sobre la función/clase.¿Cómo hacer que Qt Creator muestre la documentación emergente de mis funciones de la misma forma que lo hace para las funciones de la biblioteca de Qt?

Para mis funciones/clases tengo documentación en el formato de doxygen:

/** 
    Returns foo 
*/ 
QString getFoo() { 
    return "foo"; 
} 

Cuando se utiliza esta función, quiero ver el mismo tipo de pop-up con mis documentos cuando el puntero del ratón está sobre el nombre de la función.

¿Es posible hacer eso con Qt Creator?

Respuesta

10

Desafortunadamente, no es posible que Qt Creator (a partir del último lanzamiento 2.4) recoja las etiquetas sobre la marcha. Sin embargo, lo que podría funcionar es dejar que doxygen se ejecute, y decirle que cree archivos qch. Si registra el archivo qch creado, debe obtener el mouse e incluso un archivo de ayuda adecuado. Consulte http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help para saber cómo lo hace Ogre3D. YMMV si eso vale la pena para un proyecto que cambia rápidamente. Sin duda es una buena idea para una biblioteca (semi) estable.

pertinente informe de error: https://bugreports.qt.io/browse/QTCREATORBUG-4557

+0

Lamento que esto no sea posible. Como ya muestra la declaración de función al pasar el mouse sobre la marcha, está muy cerca de mostrar los documentos también, lo que sería increíble. El enfoque de generar archivos qch puede funcionar, pero no es conveniente si está desarrollando activamente una biblioteca, que es lo que hago a diario. –

+2

Estoy de acuerdo, pero ni siquiera puedo encontrar un problema al respecto en la base de datos de errores. Es posible que desee presentar un informe de errores en http://bugreports.qt.nokia.com o suscribirse a la lista de correo de qt-creator para ayudar a implementar esa característica. – danimo

+0

@danimo ¿Sigue siendo válido para Qt Creator versión 4.2.0? – maxik

3

Qt Creator requiere los documentos generados a tener algunos marcadores especiales con el fin de recuperar el texto de información sobre herramientas. No pude encontrar una manera de insertar estos marcadores con Doxygen por lo que he creado un script sencillo para hacerlo:

https://github.com/mmmarcos/doxygen2qtcreator

que no es a prueba de balas, pero nos permite integrar nuestras clases y métodos escritos en Qt Tooltips del creador

Cuestiones relacionadas