Building Qt Documentation/ja: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
[[ | [[Building_Qt_Documentation|English]] [[Building_Qt_Documentation_Russian|Русский]] [[Building_Qt_Documentation_Italian|Italiano]] [[Building_Qt_Documentation_Spanish|Spanish]] '''日本語''' | ||
=Qt ドキュメントのビルド方法= | = Qt ドキュメントのビルド方法 = | ||
Qt のドキュメントの書き方については [[ | Qt のドキュメントの書き方については [[Writing Qt Documentation]] を参照してください。 | ||
==qdoc3 をビルドする== | == qdoc3 をビルドする == | ||
qdoc3 は Qt のドキュメントの生成に必要なため、通常の Qt のビルド手順でコンパイルされます。このため、多くの開発者は Qt の他のツールと一緒に qdoc3 をインストールしています。 | qdoc3 は Qt のドキュメントの生成に必要なため、通常の Qt のビルド手順でコンパイルされます。このため、多くの開発者は Qt の他のツールと一緒に qdoc3 をインストールしています。 | ||
==qdoc3 を実行する== | == qdoc3 を実行する == | ||
Qt のドキュメントをビルドするには二つの方法があります。 | Qt のドキュメントをビルドするには二つの方法があります。 | ||
===Qt のビルドシステムを使用する=== | === Qt のビルドシステムを使用する === | ||
コマンドラインから、ビルドツリーのルートディレクトリで ''docs'' ビルドターゲットをビルドしてください。 | コマンドラインから、ビルドツリーのルートディレクトリで ''docs'' ビルドターゲットをビルドしてください。 | ||
例えば、Linux/Unix プラットフォームの場合: | 例えば、Linux/Unix プラットフォームの場合: | ||
<code><br />cd path/to/qt-build<br />make docs<br /></code> | |||
Windows では、ネイティブの ''nmake'' を使います: | Windows では、ネイティブの ''nmake'' を使います: | ||
<code><br />cd path\to\qt-build<br />nmake docs<br /></code> | |||
===qdoc3 を直接実行する=== | '''訳注:''' "qdoc3 のバグ&quot;:http://bugreports.qt.nokia.com/browse/QTBUG-9495 のため、正常には動作しませんが、一部の日本語ドキュメントを生成する ''docs_ja_JP'' ビルドターゲットがあります。 | ||
=== qdoc3 を直接実行する === | |||
''qdoc3'' のバイナリがある場合、直接実行してドキュメントを生成することが出来ます。 | ''qdoc3'' のバイナリがある場合、直接実行してドキュメントを生成することが出来ます。 | ||
| Line 31: | Line 35: | ||
例えば、Linux/Unix プラットフォームの場合: | 例えば、Linux/Unix プラットフォームの場合: | ||
<code><br />cd path/to/qt-build<br />bin/qdoc3 tools/qdoc3/test/qt-api-only.qdocconf<br /></code> | |||
==qdoc3 を最小限の Qt のビルドでコンパイルする== | '''訳注:''' この手法で日本語ドキュメントを生成する場合、 <code&gt;tools/qdoc3/test/qt-api-only.qdocconf&lt;/code&gt; ではなく <code&gt;tools/qdoc3/test/qt-api-only_ja_JP.qdocconf&lt;/code&gt; を指定してください。 | ||
== qdoc3 を最小限の Qt のビルドでコンパイルする == | |||
理想的には、簡単なビルドルールで、qdoc3 に必要な最小限の Qt ライブラリをビルドすることは可能です。qdoc3 のビルドに必要最小限の Qt ライブラリをビルドするには、いくつかのビルドルールをマニュアルで呼び出す必要があります。ビルドツリーのルートディレクトリで、下記のルールを呼び出してください。 | 理想的には、簡単なビルドルールで、qdoc3 に必要な最小限の Qt ライブラリをビルドすることは可能です。qdoc3 のビルドに必要最小限の Qt ライブラリをビルドするには、いくつかのビルドルールをマニュアルで呼び出す必要があります。ビルドツリーのルートディレクトリで、下記のルールを呼び出してください。 | ||
Linux/Unix プラットフォームの場合: | Linux/Unix プラットフォームの場合: | ||
<code><br />make sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3<br /></code> | |||
Windows の場合: | Windows の場合: | ||
<code><br />nmake sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3<br /></code> | |||
Revision as of 10:44, 24 February 2015
English Русский Italiano Spanish 日本語
Qt ドキュメントのビルド方法
Qt のドキュメントの書き方については Writing Qt Documentation を参照してください。
qdoc3 をビルドする
qdoc3 は Qt のドキュメントの生成に必要なため、通常の Qt のビルド手順でコンパイルされます。このため、多くの開発者は Qt の他のツールと一緒に qdoc3 をインストールしています。
qdoc3 を実行する
Qt のドキュメントをビルドするには二つの方法があります。
Qt のビルドシステムを使用する
コマンドラインから、ビルドツリーのルートディレクトリで docs ビルドターゲットをビルドしてください。
例えば、Linux/Unix プラットフォームの場合:
<br />cd path/to/qt-build<br />make docs<br />
Windows では、ネイティブの nmake を使います:
<br />cd path\to\qt-build<br />nmake docs<br />
訳注: "qdoc3 のバグ":http://bugreports.qt.nokia.com/browse/QTBUG-9495 のため、正常には動作しませんが、一部の日本語ドキュメントを生成する docs_ja_JP ビルドターゲットがあります。
qdoc3 を直接実行する
qdoc3 のバイナリがある場合、直接実行してドキュメントを生成することが出来ます。
コマンドラインから、 ＿QTDIR_ と QT_SOURCE_TREE 環境変数を Qt のソースツリーのルートディレクトリに設定して、ビルドツリーのルートで qdoc3 を実行します。
例えば、Linux/Unix プラットフォームの場合:
<br />cd path/to/qt-build<br />bin/qdoc3 tools/qdoc3/test/qt-api-only.qdocconf<br />
訳注: この手法で日本語ドキュメントを生成する場合、 <code>tools/qdoc3/test/qt-api-only.qdocconf</code> ではなく <code>tools/qdoc3/test/qt-api-only_ja_JP.qdocconf</code> を指定してください。
qdoc3 を最小限の Qt のビルドでコンパイルする
理想的には、簡単なビルドルールで、qdoc3 に必要な最小限の Qt ライブラリをビルドすることは可能です。qdoc3 のビルドに必要最小限の Qt ライブラリをビルドするには、いくつかのビルドルールをマニュアルで呼び出す必要があります。ビルドツリーのルートディレクトリで、下記のルールを呼び出してください。
Linux/Unix プラットフォームの場合:
<br />make sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3<br />
Windows の場合:
<br />nmake sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3<br />