QDocを始める

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

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

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

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

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

章立て

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