マクロ

マクロ変数を使用して、独自のシンプルな QDoc コマンドを作成できます。

マクロは次のような場合に役立ちます：

• 書式設定されたテキストスニペットなど、繰り返し使用するテキストをドキュメントに組み込む場合。
• ビルドシステムからバージョン文字列などの情報を.documentationに取り込むこと。
• 製品名など、将来変更される可能性のある文字列を一箇所で管理すること。
• 用語や製品名が一貫して使用されるようにする。
• 強制改行や特殊文字など、HTMLやDocBook要素を使用して、生成されたドキュメントのスタイルを設定する。
• たとえば、タブを使用して、さまざまなプログラミング言語、オペレーティングシステム、またはツールに関するコンテンツの例を表示する。

グローバルマクロ

すべてのドキュメントプロジェクトで使用できる、事前定義されたグローバルマクロのセットとその現在の値については、/qtbase/doc/global/macros.qdocconfおよび/qtbase/doc/global/htmltabs.qdocconf を参照してください。これらには、次のようなマクロが含まれています。

• CMake テキストスニペット
• HTML および DocBook の書式設定
• 製品名
• 製品バージョン
• タブ付きコンテンツ
• YouTube コンテンツへのリンク
• その他のマクロ

Qt Online Installer は、マクロファイルを Qt のインストールフォルダにコピーします。これにより、ソースから QDoc を自分でビルドするのではなく、インストール済みの Qt から QDoc を使用してドキュメントをビルドする場合でも、マクロを使用できるようになります。

マクロの追加

特定のドキュメントプロジェクト用のマクロは、そのプロジェクトの .qdocconf ファイル、またはそのプロジェクトにインクルードされている任意の .qdocconf ファイルに追加できます。そのマクロが複数のドキュメントプロジェクトで有用である場合は、グローバルマクロファイルに追加してください。

マクロの構文やオプションの詳細については、macro を参照してください。

マクロの使用

マクロは、以下の場所にある組み込みの QDoc コマンドと同じ方法で使用できます。

• コードソースファイル内のドキュメントコメント（.cpp、.qml）
• ドキュメントソースファイル（.qdoc、.qdocinc）

例：

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

廃止されたマクロ

グローバルマクロファイルには、古いドキュメントセットとの互換性を保つために、以下の廃止されたマクロが含まれています。