QDoc の使い始め

Qt は、QDoc を使用してドキュメントセットを HTML および DocBook XML 形式で生成します。QDoc は、一連の設定ファイルを使用して、QDoc コメントからドキュメントを生成します。コメントには「トピック」と呼ばれるタイプがあり、それによってコメントがクラスのドキュメントであるか、プロパティのドキュメントであるかが決まります。また、コメントには、最終出力のレイアウトや書式設定を向上させるためのマークアップを含めることもできます。

QDoc を使用してドキュメントを生成するには、次の 3 つの必須要素が必要です：

• QDoc バイナリ
• qdocconf 設定ファイル
• Documentation C++ 、 、および ファイル内の構成ファイルQML .qdoc

Q Docでは、C++ヘッダーファイルやソースファイルの解析、および \fn コマンド内の関数シグネチャを解析するために、Clangが必要です。詳細については、「QDoc用のClangのインストール」を参照してください。

このセクションでは、ドキュメントセットを作成するために必要な基本事項について解説します。さらに、このガイドでは、C++ 以外の API ドキュメントや QML ドキュメントを作成する際の特別な考慮事項やオプションについても説明します。最後に、サンプルプロジェクトのドキュメントと、QML 型ドキュメントの例を紹介します。

QDocに関する具体的な情報については、『QDocマニュアル』を参照してください。

章

1. QDoc 用の Clang のインストール
2. QDoc 設定ファイルの作成
3. ドキュメントの作成
4. ドキュメントのカテゴリ
   • C++ ドキュメントのスタイル
   • QML ドキュメントのスタイル
5. QDocの警告のトラブルシューティング