QDocを始める

Qt は QDoc を使って HTML や DocBook XML 形式のドキュメントを生成します。QDocはQDocのコメントからドキュメントを生成するために設定ファイルを使います。コメントにはトピックと呼ばれる型があり、コメントがクラス・ドキュメントなのかプロパティ・ドキュメントなのかを決定します。コメントには、最終的な出力のレイアウトや書式を向上させるためのマークアップもあります。

QDocでドキュメントを生成するために必要な素材は3つあります：

• QDoc バイナリ
• qdocconf 設定ファイル
• Documentation C++, , ファイルにあります。QML .qdoc

QDocは、C++ヘッダー・ファイルとソース・ファイルを解析するため、また、 ⅳfnコマンドの関数シグネチャを解析するためにClangを必要とします。詳細はClang for QDocのインストールを参照してください。

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

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

章立て

1. QDoc用Clangのインストール
2. QDoc設定ファイルの作成
3. ドキュメントの書き方
4. ドキュメントのカテゴリー
   • C++ドキュメントのスタイル
   • QMLドキュメントのスタイル
5. QDocの警告を解決する方法