Wie mache ich Qt Creator dazu, eine Pop-up-Dokumentation meiner Funktionen anzuzeigen, so wie es für die Funktionen aus der Qt-Bibliothek funktioniert? - qt, qt-Schöpfer

Wenn Sie den Mauszeiger über eine Qt-Funktion / -Klasse halten, wird ein Popup mit einer kurzen Beschreibung dessen angezeigt, was aus den Dokumenten im Kommentar über der Funktion / Klasse stammt.

Für meine Funktionen / Klassen habe ich Dokumentation im Doxygen-Format:

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

Wenn diese Funktion verwendet wird, möchte ich dieselbe Art von Popup mit meinen Dokumenten anzeigen, wenn sich der Mauszeiger über dem Funktionsnamen befindet.

Ist es möglich, dies mit Qt Creator zu tun?

Antworten:

Leider ist es für Qt Creator nicht möglich(ab der letzten Version 2.4), um die Tags im Handumdrehen aufzunehmen. Was jedoch funktionieren könnte ist, doxygen laufen zu lassen und ihm zu sagen, dass er qch-Dateien erstellen soll. Wenn Sie die erstellte qch-Datei registrieren, sollten Sie die Maus über und sogar eine richtige Hilfedatei bekommen. Sehen http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help wie Ogre3D es macht. YMMV, wenn es sich für ein sich schnell änderndes Projekt lohnt. Es ist sicherlich eine gute Idee für eine (halb-) stabile Bibliothek.

Relevanter Fehlerbericht: https://bugreports.qt.io/browse/QTCREATORBUG-4557

Qt Creator benötigt die generierten Dokumenteeinige spezielle Markierungen, um den Tooltip-Text abzurufen. Ich konnte keine Möglichkeit finden, diese Marker mit Doxygen einzufügen, also habe ich ein einfaches Skript dafür erstellt:

https://github.com/mmmarcos/doxygen2qtcreator

Es ist nicht kugelsicher, aber es erlaubt uns, unsere Klassen- und Methodenseiten in Qt Creator Tooltips zu integrieren.