Makros

Verwenden Sie die Makro-Variable, um Ihre eigenen einfachen QDoc-Befehle zu erstellen.

Makros sind nützlich für:

• Einfügen von wiederkehrendem Text, wie z.B. formatierte Textschnipsel, in die Dokumentation.
• Informationen, wie z.B. Versionsstrings, aus dem Build-System in die Dokumentation einzubinden.
• Beibehaltung eines einzigen Ortes für Zeichenfolgen, die sich in der Zukunft wahrscheinlich ändern werden, wie z. B. Produktnamen.
• Sicherstellen, dass ein Begriff oder Produktname einheitlich verwendet wird.
• Gestaltung der generierten Dokumentation durch Verwendung von HTML- und DocBook-Elementen, wie z. B. erzwungene Zeilenumbrüche und Sonderzeichen.
• Verwendung von Tabs, um Beispiele für Inhalte in verschiedenen Programmiersprachen, Betriebssystemen oder Werkzeugen zu zeigen, zum Beispiel.

Globale Makros

Eine Reihe vordefinierter globaler Makros, die Sie in allen Dokumentationsprojekten verwenden können, sowie deren aktuelle Werte finden Sie in /qtbase/doc/global/macros.qdocconf und /qtbase/doc/global/htmltabs.qdocconf. Sie haben Makros, die einschließen:

• CMake-Textschnipsel
• HTML- und DocBook-Formatierung
• Produkt-Namen
• Produktversionen
• Registerkarten-Inhalt
• Links zu YouTube-Inhalten
• Verschiedene Makros

Qt Online Installer kopiert die Makrodateien in Ihren Qt-Installationsordner, so dass Sie die Makros auch dann verwenden können, wenn Sie die Dokumentation mit QDoc aus einem installierten Qt erstellen (im Gegensatz zu QDoc, das Sie selbst aus den Quellen erstellen).

Hinzufügen von Makros

Sie können Makros für ein bestimmtes Dokumentationsprojekt in der .qdocconf-Datei des Projekts oder einer beliebigen .qdocconf-Datei, die Sie in das Projekt einbinden, hinzufügen. Wenn das Makro in mehr als einem Dokumentationsprojekt nützlich sein könnte, fügen Sie es der globalen Makrodatei hinzu.

Weitere Informationen über die Makrosyntax und -optionen finden Sie unter macro.

Verwendung von Makros

Sie können Makros in der gleichen Weise wie die eingebauten QDoc-Befehle verwenden:

• Code-Quelldateien, in Dokumentationskommentaren (.cpp, .qml)
• Dokumentations-Quelldateien (.qdoc, .qdocinc)

Zum Beispiel:

\QOI copies the macros files to your Qt installation folder.

Obsolete Makros

Die globale Makros-Datei enthält die folgenden veralteten Makros für die Kompatibilität mit älteren Dokumentations-Sets.