Erste Schritte mit QDoc

Qt verwendet QDoc, um seine Dokumentation in den Formaten HTML und DocBook XML zu generieren. QDoc nutzt eine Reihe von Konfigurationsdateien, um aus QDoc-Kommentaren Dokumentation zu erstellen. Die Kommentare verfügen über Typen, sogenannte „Topics“, die festlegen, ob es sich bei einem Kommentar um eine Klassendokumentation oder eine Eigenschaftsdokumentation handelt. Ein Kommentar kann außerdem Markups enthalten, um das Layout und die Formatierung der endgültigen Ausgabe zu verbessern.

Für die Erstellung von Dokumentation mit QDoc sind drei wesentliche Komponenten erforderlich:

• QDoc Binär-
• qdocconf Konfigurationsdateien
• Documentation in den Dateien „ C++ “, „ QML “ und „ .qdoc “

QDoc benötigt Clang zum Parsen von C++-Header- und Quelldateien sowie zum Parsen der Funktionssignaturen in \fn Befehlen. Weitere Informationen finden Sie unter „Clang für QDoc installieren “.

Dieser Abschnitt behandelt die grundlegenden Voraussetzungen für die Erstellung eines Dokumentationssatzes. Darüber hinaus werden in diesem Leitfaden besondere Überlegungen und Optionen zur Dokumentation von Nicht-C++-APIs sowie zur QML-Dokumentation vorgestellt. Abschließend enthält der Leitfaden ein Beispielprojekt zur Dokumentation sowie ein Beispiel für die Dokumentation eines QML-Typs.

Spezifische Informationen zu QDoc finden Sie im QDoc-Handbuch.

Kapitel

1. Installation von Clang für QDoc
2. Erstellen von QDoc-Konfigurationsdateien
3. Dokumentation verfassen
4. Kategorien der Dokumentation
   • C++-Dokumentationsstil
   • QML-Dokumentationsstil
5. Behebung von QDoc-Warnungen