Building Qt Documentation/ja: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
m (AutoSpider moved page Building Qt Documentation Japanese to Building Qt Documentation/ja: Localisation)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Building Qt Documentation|English]] [[Building Qt Documentation Russian|Русский]] [[Building Qt Documentation Italian|Italiano]] [[Building Qt Documentation Spanish|Spanish]] '''日本語'''
{{Cleanup | reason=Auto-imported from ExpressionEngine.}}


=Qt ドキュメントのビルド方法=
[[Building_Qt_Documentation|English]] [[Building_Qt_Documentation_Russian|Русский]] [[Building_Qt_Documentation_Italian|Italiano]] [[Building_Qt_Documentation_Spanish|Spanish]] '''日本語'''


Qt のドキュメントの書き方については [[Writing-Qt-Documentation|Writing Qt Documentation]] を参照してください。
= Qt ドキュメントのビルド方法 =


==qdoc3 をビルドする==
Qt のドキュメントの書き方については [[Writing Qt Documentation]] を参照してください。
 
== qdoc3 をビルドする ==


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


==qdoc3 を実行する==
== qdoc3 を実行する ==


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


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


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


例えば、Linux/Unix プラットフォームの場合:
例えば、Linux/Unix プラットフォームの場合:
<code>
cd path/to/qt-build
make docs
</code>


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


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


===qdoc3 を直接実行する===
=== qdoc3 を直接実行する ===


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


例えば、Linux/Unix プラットフォームの場合:
例えば、Linux/Unix プラットフォームの場合:
<code>
cd path/to/qt-build
bin/qdoc3 tools/qdoc3/test/qt-api-only.qdocconf
</code>


'''訳注:''' この手法で日本語ドキュメントを生成する場合、 <code>tools/qdoc3/test/qt-api-only.qdocconf</code> ではなく <code>tools/qdoc3/test/qt-api-only_ja_JP.qdocconf</code> を指定してください。
'''訳注:''' この手法で日本語ドキュメントを生成する場合、 <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 ライブラリをビルドすることは可能です。qdoc3 のビルドに必要最小限の Qt ライブラリをビルドするには、いくつかのビルドルールをマニュアルで呼び出す必要があります。ビルドツリーのルートディレクトリで、下記のルールを呼び出してください。
理想的には、簡単なビルドルールで、qdoc3 に必要な最小限の Qt ライブラリをビルドすることは可能です。qdoc3 のビルドに必要最小限の Qt ライブラリをビルドするには、いくつかのビルドルールをマニュアルで呼び出す必要があります。ビルドツリーのルートディレクトリで、下記のルールを呼び出してください。


Linux/Unix プラットフォームの場合:
Linux/Unix プラットフォームの場合:
<code>
make sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3
</code>


Windows の場合:
Windows の場合:


===Categories:===
<code>
 
nmake sub-tools-bootstrap sub-moc sub-corelib sub-xml sub-qdoc3
* [[:Category:Developing Qt|Developing_Qt]]
</code>
** [[:Category:Developing Qt::Documentation|Documentation]]

Latest revision as of 15:57, 16 March 2015

This article may require cleanup to meet the Qt Wiki's quality standards. Reason: Auto-imported from ExpressionEngine.
Please improve this article if you can. Remove the {{cleanup}} tag and add this page to Updated pages list after it's clean.

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 のバグ のため、正常には動作しませんが、一部の日本語ドキュメントを生成する 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