2010-06-17 6 views
5

Wo finde ich Dokumentation für Qt-Dokumentationskommentare? Ich beziehe mich darauf, wie Qt einen bestimmten Stil für Dokumentationskommentare verwendet, wie zum Beispiel:Dokumentation für Kommentare zur Qt-Dokumentation? Qt + Doxygen?

... Sie erhalten das Bild. Wo finde ich Informationen zu allen Schaltern, wie \ class, \ list, \ brief usw. Welche Werkzeuge verwende ich auch, um Dokumentationsdateien aus diesen Kommentaren in meinen Quelldateien zu generieren? Unterstützt Doxygen diese Syntax?

Antwort

8

Verwenden Sie nicht qdoc. It is deprecated. Verwenden Sie Doxygen, das sowieso auf qdoc basiert.

Das heißt, die Dokumentation (im qdoc-Format: -D) ist here.

+1

Ich war auf der Suche nach http: //qt.gitorious .org/qt/pages/DocManual und http://qt.gitorious.org/qt/pages/DocMarkupCommands. Ohne zu wissen, wie es heißt (qdoc, wie?), Konnte ich es nicht googeln. Viele der Links scheinen jedoch tot zu sein. –

+2

Jetzt sagen Sie, dass das qdoc * -Tool veraltet ist oder die gesamte qdoc * -Syntax * (einschließlich des Tools) veraltet ist? Nokia verwendet die qdoc-Syntax ausschließlich in Qt, ist das nur aus Gründen der Rückwärtskompatibilität oder sollte stattdessen ein anderer Stil (wie Javadoc-Kommentare) verwendet werden? Offensichtlich liegt es an einem Programmierer, aber ich möchte mit dem Rest von Qt oder dem, was Nokia empfiehlt, konsistent bleiben. –

+0

Danke für die Info, das hat mir viel Zeit erspart. Ich ging für qdoc3 ... Narr! – karlphillip

0

Sie einen Blick auf die Qt-Quellcode nehmen sich für die Qt-Dokumentation Kommentare ...

Qt - SRC - 4.6.3

I Doxygen für die Dokumentation verwendet haben und für mich ist es funktioniert gut, obwohl die Dokumentation Standards sind nicht von Qt. Ich schlage vor, dass Sie es versuchen und entscheiden.

1

Verwenden Doxygen Dokumentation erstellen

Es kann einen Online-Dokumentation Browser (in HTML) erzeugen und/oder ein Offline-Referenzhandbuch (LaTeX) aus einer Reihe von dokumentierten Quelldateien. Es gibt auch Unterstützung für das Generieren von Ausgaben in RTF (MS-Word), PostScript, hyperlinked PDF, komprimiertem HTML und Unix man-Seiten. Die Dokumentation wird direkt aus den Quellen extrahiert, wodurch die Dokumentation viel einfacher mit dem Quellcode übereinstimmt.

Sie können doxygen konfigurieren, um die Code-Struktur aus undokumentierten Quelldateien zu extrahieren. Dies ist sehr nützlich, um sich schnell in großen Quelldistributionen zurecht zu finden. Sie können die Beziehungen zwischen den verschiedenen Elementen auch mithilfe von Abhängigkeitsgraphen, Vererbungsdiagrammen und Zusammenarbeitsdiagrammen visualisieren, die alle automatisch generiert werden.

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

1

Es gibt zwei Teile von Doxygen, die qt spezifischen sind: der Qt Kommentar Stil und der QT_AUTOBRIEF doxyfile Konfigurations-Tag. Dies sind nur Teile von Doxygen, die von QT verwendet werden. Alle von QT verwendeten doxygen Kommentare sind reguläres Doxygen. Sie müssen also nur auf Doxygen nachlesen.

Oder vielleicht sind Sie wirklich für die Dokumentation von QT Interna suchen, wie zum Beispiel Informationen über d-Pointers wie in this blog entry

Qt-Art-Kommentare enthalten: Die \ *! text */ Kommentarstil wird als "Qt Style" von doxgyen comments bezeichnet. Das "!" markiert den gesamten Kommentarblock als doxygen Kommentarblock. Es ist ein standardmäßiger, optionaler Teil von Doxygen.

QT_AUTOBRIEF Einstellung: wenn die „QT_AUTOBRIEF“ -Tag auf TRUE in der Doxyfile gesetzt, die erste Zeile eines Kommentars Block Qt Stil automatisch als \ Kurzbeschreibung interpretiert wird.

Vom doygen GUI-Hilfe:

QT_AUTOBRIEF Tag auf YES gesetzt ist dann Doxygen werden die erste Linie (bis zum ersten Punkt) eines Qt-Stil Kommentar als kurze Beschreibung interpretieren. Wenn auf NO gesetzt, verhalten sich die Kommentare wie normale Qt-Stil Kommentare (also einen expliziten \ kurzen Befehl für eine kurze Beschreibung erfordern.)