派生プロジェクトのサポート

いくつかの設定変数によって、QDocを使ってQtベースのプロジェクトをサポートすることができます。これらの設定変数によって、プロジェクトにオンライン Qt ドキュメントへのリンクを含めることができ、明示的なリンクコマンドを使わなくても、QDoc がクラス参照ドキュメントへのリンクを作成できるようになります。

説明

description変数は、関連するプロジェクトの短い説明を保持します。

projectも参照してください。

インデックス

indexes 変数は、読み込むインデックス・ファイルのパスのセットを定義する。

indexes = \
    $QT_INSTALL_DOCS/qtcore/qtcore.index \
    $SOME_OTHER_PROJECT/doc/foo.index

indexes 変数はプロジェクトの依存関係を定義するためのdependsに代わるものです。直接パスが提供されるので、QDocを起動するときに-indexdir コマンドラインオプションは必要ありません。

どちらの変数を使っても依存関係を定義できます。Qt ドキュメントはdepends 変数のみを使用します。

depends,project,url も参照してください。

プロジェクト

project 変数は.qdocconf ファイルに関連付けられたプロジェクトの名前を提供します。これはすべてのプロジェクトが設定しなければならない必須の変数です。

プロジェクト名は、関連するプロジェクトのインデックスファイルのファイル名を形成するために使用されます。

project = QtCreator

これにより、qtcreator.index というインデックスファイルが作成されます。

プロジェクト名に空白文字や特殊文字が含まれている場合、生成されるインデックスファイル名ではダッシュ('-')に置き換えられます。

depends、indexes、descriptionも参照してください。

url

url 変数は現在のプロジェクトに関連するドキュメントのベース URL を保持します。

このURLはプロジェクトの生成されたインデックスファイルに格納されます。インデックスをそれ自身で使うとき、QDocはインデックスにリストされたクラスや関数などへのリンクを構築するときに、これをベースURLとして使います。

project     = QtCore
description = Qt Core Reference Documentation
url         = https://doc.qt.io/qt/

...

これにより、QDocがQt Coreモジュールのエンティティへの参照を生成するときはいつでも、ベースURLがhttps://doc.qt.io/qt/ 。

depends、indexes、url.examplesも参照してください。

url.examples

url.examples 変数は、現在のプロジェクトに関連するサンプルのベースURLを保持します。

もし定義されていれば、各サンプルドキュメンテーションのページの最後にサンプルプロジェクトのディレクトリへのリンクが生成されます。url.examples 変数は、このプロジェクトに関連するサンプルのルートディレクトリを参照します。オンラインリポジトリ（http://またはhttps:// で始まる）へのリンク、またはローカルファイルシステム（file:// ）へのリンクにすることができます。

url.examples が定義されていない場合、QDocは代わりにサンプルのファイルとイメージのリストを出力します。

例えば、以下の定義があるとします：

url.examples = "https://code.qt.io/cgit/qt/qtbase.git/tree/examples/"
examplesinstallpath = corelib

例えば、以下のように定義されているとします：

/*!
    \example threads/semaphores
    ...
*/

QDocはhttps://code.qt.io/cgit/qt/qtbase.git/tree/examples/corelib/threads/semaphores へのリンクを生成します。

URLの例パスの後にさらにコンポーネント（例えば、クエリ文字列）が含まれている場合は、パスのプレースホルダとして˶1が使用できます：

url.examples = "https://code.qt.io/cgit/qt/qtbase.git/tree/examples/\1?h=$QT_VER"
examplesinstallpath = corelib

上述と同じ" \example" コマンドが与えられ、$QT_VER が5.13 に展開されると仮定すると、生成される URL はhttps://code.qt.io/cgit/qt/qtbase.git/tree/examples/corelib/threads/semaphores?h=5.13 になります。

url.examples 変数はQDocバージョン5.13で導入されました。

url、examplesinstallpath、そして\exampleも参照してください。

派生プロジェクトのサポート方法

この機能は、Qt 参照ドキュメントを作成するときに QDoc によって生成される包括的なインデックスを利用します。

例えば、qtgui.qdocconf（Qt GUIの設定ファイル）には以下の変数定義があります：

project     = QtGui
description = Qt GUI Reference Documentation
url         = http://doc.qt.io/qt/

...

プロジェクト変数名は、インデックスファイルのファイル名を形成するために使用されます。この場合、qtgui.index ファイルが作成されます。urlはインデックス・ファイルに保存されます。その後、QDocはインデックスに記載されているクラスや関数などへのリンクを構築する際に、これをベースURLとして使用します。

depends、indexes、project、urlも参照してください。