2011-12-13 6 views
19

Quando posizioni il puntatore del mouse su una qualsiasi funzione/classe Qt mostra un popup con una breve descrizione di ciò che fa, preso dai documenti nel commento sopra la funzione/classe.Come rendere Qt Creator per mostrare la documentazione pop-up delle mie funzioni nello stesso modo in cui funziona con le funzioni della libreria Qt?

Per le mie funzioni/classi che ho la documentazione in formato doxygen:

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

Quando si utilizza questa funzione, voglio vedere lo stesso tipo di pop-up con i miei documenti quando il puntatore del mouse si trova sopra il nome della funzione.

È possibile farlo con Qt Creator?

risposta

10

Sfortunatamente non è possibile per Qt Creator (come della recente versione 2.4) ritirare i tag al volo. Tuttavia, ciò che potrebbe funzionare è far funzionare doxygen e dirgli di creare file qch. Se registri il file qch creato, dovresti ottenere il mouse e persino un file di aiuto corretto. Vedi http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help per come fa Ogre3D. YMMV se ne vale la pena per un progetto in rapida evoluzione. È certamente una buona idea per una libreria (semi) stabile.

Rilevante bug report: https://bugreports.qt.io/browse/QTCREATORBUG-4557

+0

Mi dispiace sapere che questo non è possibile. Come già mostra la dichiarazione della funzione al passaggio del mouse al volo, è molto vicino a mostrare anche i documenti, il che sarebbe fantastico. L'approccio alla generazione di file qch probabilmente funzionerà, ma non è conveniente se si sta sviluppando attivamente una libreria, che è ciò che faccio quotidianamente. –

+2

Sono d'accordo, ma non riesco nemmeno a trovare un problema al riguardo nel database dei bug. Si consiglia di inviare una segnalazione di errore su http://bugreports.qt.nokia.com o di iscriversi alla mailing list qt-creator per aiutare a implementare tale funzionalità. – danimo

+0

@danimo È ancora valido per Qt Creator versione 4.2.0? – maxik

3

Qt Creator richiede i documenti generati per avere alcuni marcatori speciali al fine di recuperare il testo tooltip. Non riuscivo a trovare un modo per inserire questi marcatori con Doxygen così ho creato un semplice script per farlo:

https://github.com/mmmarcos/doxygen2qtcreator

non è a prova di proiettile, ma ci permette di integrare le nostre classi e metodi slip in Qt Suggerimenti per i creativi.

Problemi correlati