Erste Schritte mit QDoc

Qt verwendet QDoc, um seine Dokumentation in den Formaten HTML und DocBook XML zu erzeugen. QDoc verwendet eine Reihe von Konfigurationsdateien, um Dokumentation aus QDoc-Kommentaren zu erzeugen. Die Kommentare haben Typen, die Themen genannt werden, die bestimmen, ob ein Kommentar eine Klassendokumentation oder eine Eigenschaftsdokumentation ist. Ein Kommentar kann auch Markierungen enthalten, um das Layout und die Formatierung der endgültigen Ausgabe zu verbessern.

Es gibt drei wesentliche Materialien für die Erzeugung von Dokumentation mit QDoc:

• QDoc Binärdateien
• qdocconf Konfigurationsdateien
• Documentation in den Dateien C++, QML, und .qdoc

Dieser Abschnitt soll die grundlegenden Notwendigkeiten für die Erstellung einer Dokumentationsmenge abdecken. Darüber hinaus werden spezielle Überlegungen und Optionen für die Dokumentation von Nicht-C++-API-Dokumentation und QML-Dokumentation vorgestellt. Schließlich enthält der Leitfaden eine Beispielprojektdokumentation und ein Beispiel für eine QML-Typdokumentation.

Spezifische Informationen zu QDoc finden Sie im QDoc-Handbuch.

Kapitel

1. Installieren von Clang für QDoc
2. Erstellen von QDoc-Konfigurationsdateien
3. Dokumentation schreiben
4. Kategorien der Dokumentation
   • Stil der C++-Dokumentation
   • QML-Dokumentationsstil
5. Wie man QDoc-Warnungen auflöst