Building Qt Documentation/ja

English Русский Italiano Spanish 日本語

Qt ドキュメントのビルド方法

Qt のドキュメントの書き方については Writing Qt Documentation を参照してください。

qdoc3 をビルドする

qdoc3 は Qt のドキュメントの生成に必要なため、通常の Qt のビルド手順でコンパイルされます。このため、多くの開発者は Qt の他のツールと一緒に qdoc3 をインストールしています。

qdoc3 を実行する

Qt のドキュメントをビルドするには二つの方法があります。

Qt のビルドシステムを使用する

コマンドラインから、ビルドツリーのルートディレクトリで docs ビルドターゲットをビルドしてください。

例えば、Linux/Unix プラットフォームの場合:

cd path/to/qt-build
make docs

Windows では、ネイティブの nmake を使います:

cd path\to\qt-build
nmake docs

訳注: "qdoc3 のバグ":http://bugreports.qt.nokia.com/browse/QTBUG-9495 のため、正常には動作しませんが、一部の日本語ドキュメントを生成する docs_ja_JP ビルドターゲットがあります。

qdoc3 を直接実行する

qdoc3 のバイナリがある場合、直接実行してドキュメントを生成することが出来ます。

コマンドラインから、 ＿QTDIR_ と QT_SOURCE_TREE 環境変数を Qt のソースツリーのルートディレクトリに設定して、ビルドツリーのルートで qdoc3 を実行します。

例えば、Linux/Unix プラットフォームの場合:

cd path/to/qt-build
bin/qdoc3 tools/qdoc3/test/qt-api-only.qdocconf

訳注: この手法で日本語ドキュメントを生成する場合、

tools/qdoc3/test/qt-api-only.qdocconf

ではなく

tools/qdoc3/test/qt-api-only_ja_JP.qdocconf

を指定してください。

qdoc3 を最小限の Qt のビルドでコンパイルする

理想的には、簡単なビルドルールで、qdoc3 に必要な最小限の Qt ライブラリをビルドすることは可能です。qdoc3 のビルドに必要最小限の Qt ライブラリをビルドするには、いくつかのビルドルールをマニュアルで呼び出す必要があります。ビルドツリーのルートディレクトリで、下記のルールを呼び出してください。

Linux/Unix プラットフォームの場合:

make sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3

Windows の場合:

nmake sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3