マクロ

マクロ変数を使用して、独自の簡単なQDocコマンドを作成します。

マクロは以下のような場合に便利です：

• フォーマットされたテキストスニペットなど、繰り返し使用されるテキストをドキュメントに含める。
• ビルドシステムから.documentationにバージョン文字列などの情報を取り込む。
• 製品名など、将来変更される可能性のある文字列を1つの場所に保持する。
• 用語や製品名が一貫して使用されるようにします。
• 強制改行や特殊文字など、HTMLやDocBookの要素を使用して、生成されるドキュメントをスタイリングする。
• タブを使用して、異なるプログラミング言語、オペレーティング・システム、ツールなどのコンテンツ例を表示する。

グローバルマクロ

すべてのドキュメントプロジェクトで使用できる定義済みのグローバルマクロのセットと現在の値については、/qtbase/doc/global/macros.qdocconfと /qtbase/doc/global/htmltabs.qdocconfを参照してください。これらのマクロには

• CMakeテキストスニペット
• HTMLとDocBookのフォーマット
• 製品名
• 製品バージョン
• タブコンテンツ
• YouTubeコンテンツへのリンク
• その他のマクロ

Qt Online Installer を実行すると、マクロファイルが Qt のインストールフォルダにコピーされます。

マクロの追加

プロジェクトの .qdocconf ファイルや、プロジェクトにインクルードする .qdocconf ファイルに、特定のドキュメンテーションプロジェクトのマクロを追加することができます。マクロが複数のドキュメンテーション・プロジェクトで有用な場合は、グローバル・マクロ・ファイルに追加してください。

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

マクロの使用

マクロは、組み込みのQDocコマンドと同じように、以下の場所で使用することができます：

• コード・ソース・ファイル、ドキュメント・コメント (.cpp, .qml)
• ドキュメント・ソース・ファイル (.qdoc, .qdocinc)

例えば

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

廃止されたマクロ

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