Qt -ドキュメントの利用方法-

Qt SDK/Nokia Qt SDKに含まれているドキュメントは QtCreatorのHelpから、あるいはQtAssitantで見ることができる。

1)QtCreatorのHelpから利用する

2)ソースコード中のクラス/メンバ関数に関するドキュメントを参照する(1)

 * 参照したいクラス名(あるいはメンバ関数)にポインタを置いてF1キーを押す。

3)ソースコード中のクラス/メンバ関数に関するドキュメントを参照する(2)

 * ソースコードに戻るには[Build Issues]ボタンを押す。

4)QtAssitantから利用する

 * QtAssitantの起動には、インストールディレクトリの下のqt/bin/assistantを実行する。

Qt SDKのドキュメント:
Qt SDKのドキュメントはインストールディレクトリの下のqt/doc/qchの下と、share/doc/qtcreatorの下に置かれていて、Qt Creatorを最初に起動した時、これが ~/.config/Nokia/qtcreator/helpcollection.qhcに設定される。

# ls qt/doc/qch
assistant.qch designer.qch linguist.qch qmake.qch qt.qch
# ls share/doc/qtcreator
qtcreator.qch

以下のコマンドを実行すると、登録されたドキュメントのnamespace(一意の名前)とファイルのパスのマッピングが表示される。
# sqlite3 ~/.config/Nokia/qtcreator/helpcollection.qhc
sqlite> select * from NamespaceTable;

Nokia Qt SDKのドキュメント:
Nokia Qt SDKのドキュメントはインストールディレクトリの下のDocumentationの下に置かれている。
しかし、最初の起動時にはドキュメントを参照できず、次のようなエラーが表示される。

The page could not be found
'qthelp://com.nokia.qtcreator.200/qdoc//doc/index.html'

ドキュメントの起点の情報が実際と違っているためと思われるが、今のところ、直しかたがわからない。
しかし、Toolsメニュー(Tools => Options => Help => Documentation)から追加できるので、支障はない。
あるいは、Nokia Qt SDKもQt SDKと同じ設定ファイル~/.config/Nokia/qtcreator/helpcollection.qhcを参照するので、qt/doc/qchの下にNokia Qt SDKのドキュメントへのシンボリックリンクを作っておき、一度Qt SDKを起動したあとにNokia Qt SDKを起動すればドキュメントを参照できる。

* Qt SDKとNokia Qt SDKには、いくつか同じnamespaceのドキュメントが含まれているが、なぜか少しだけファイルサイズが違う。まあ、当面は気にしないことにしよう。

# ls Documentation
designer.qch nokiaqtsdk.qch qt.qch qtmobility.qch
linguist.qch qmake.qch qtcreator.qch simulator.qch

Qt Assistant:
Qt Assistantでは、Qt SDKのqt/doc/qchの下にあるのと同じ次の5種類のドキュメントが登録される。

  assistant.qch designer.qch linguist.qch qmake.qch qt.qch

他のドキュメントはQt Creatorとほとんど同じ手順で編集メニューから追加できる。

 編集 => 設定 => ドキュメント

Qt Assistant のメニューは日本語化されている。
ドキュメントの設定ファイルはQt Creatorと違って.configの下ではなく.localの下に作られる。
 ~/.local/share/data/Trolltech/Assistant/qthelpcollection_4.6.3.qhc

ところで、Qtのドキュメントの名前(namespace)には、com.trolltechで始まるものと、com.nokiaで始まるものがある。
前者は買収前にTrolltechで開発されたもの、後者は買収後にNokiaで開発されたものだろうか。

ドキュメントの作成方法:
アプリケーションに組み込むためのドキュメントの作成方法は[Generating Qt Help]に書かれている。

[Qt Reference Documentation]=>[Frameworks and Technologies]=>[The Qt Help Framework]=>[Generating Qt Help]

1. ドキュメントをHTMLで作成
2. Qt Help Project(.qhp)をXMLで作成
3. Qt Compressed Help(.qch)を生成
4. Qt Help Collection(.qhc)を生成

これである程度の準備ができたので、次はモバイルアプリケーションの作成方法を調べてみようと思う。