マクロ
マクロ変数を使用して、独自の簡単なQDocコマンドを作成します。
マクロは以下のような場合に便利です：
- フォーマットされたテキストスニペットなど、繰り返し使用されるテキストをドキュメントに含める。
- ビルドシステムから.documentationにバージョン文字列などの情報を取り込む。
- 製品名など、将来変更される可能性のある文字列を1つの場所に保持する。
- 用語や製品名が一貫して使用されるようにします。
- 強制改行や特殊文字など、HTMLやDocBookの要素を使用して、生成されるドキュメントをスタイリングする。
- タブを使用して、異なるプログラミング言語、オペレーティング・システム、ツールなどのコンテンツ例を表示する。
グローバルマクロ
すべてのドキュメントプロジェクトで使用できる定義済みのグローバルマクロのセットとその現在の値については、/qtbase/doc/global/macros.qdocconfと /qtbase/doc/global/htmltabs.qdocconfを参照してください。これらのマクロには
Qt オンラインインストーラは、マクロファイルを Qt インストールフォルダにコピーしますので、インストールされた Qt から QDoc を使ってドキュメントをビルドする場合でも（ソースから QDoc をビルドする場合とは異なり）、マクロを使用することができます。
注意： グローバルマクロの値は Qt のバージョンによって変わる可能性があります。そのため、ドキュメンテーションのビルドに使用する Qt のバージョンによって、マクロの拡張が異なる可能性があります。
マクロの追加
プロジェクトの .qdocconf ファイルや、プロジェクトにインクルードする .qdocconf ファイルに、特定のドキュメンテーションプロジェクトのマクロを追加することができます。マクロが複数のドキュメンテーション・プロジェクトで有用な場合は、グローバル・マクロ・ファイルに追加してください。
マクロの構文とオプションの詳細については、マクロを参照してください。
マクロの使用
マクロは、組み込みのQDocコマンドと同じように、以下の場所で使用することができます：
- コード・ソース・ファイル、ドキュメント・コメント (.cpp, .qml)
- ドキュメント・ソース・ファイル (.qdoc, .qdocinc)
例えば
\QOI copies the macros files to your Qt installation folder.
廃止されたマクロ
グローバル・マクロ・ファイルには、古いドキュメンテーション・セットとの互換性のために、以下の廃止されたマクロが含まれています。
| 使用しない | 使用する |
|---|---|
| \使用しないでください。 | \を使用しないでください。 |
| \メニュー | \gui(メニュー) |
| \パラメータ | \a |
| \リターン | 戻り値またはリターンを書き込みます。 |
macroおよびUnknown macroも参照してください 。
この文書に含まれる文書の著作権は、それぞれの所有者に帰属します。 ここで提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
