QDoc設定ファイル

QDocを実行する前に、QDoc設定ファイルを作成して、QDocコメントを含むソース・ファイルの場所をQDocに指示する必要があります。設定ファイルのパス名はコマンドラインでQDocに渡されます：

/current/dir$ ../../bin/qdoc ./config.qdocconf

一般的な説明

設定ファイルは"variable = value "という形式のエントリーのリストです。設定変数を使うことで、QDocが様々なソースファイル、イメージ、サンプルを見つける場所、生成されたドキュメントを置く場所などを定義することができます。設定ファイルには、include のようなディレクティブを含めることもできます。例としてはminimum.qdocconfを見てください。

設定変数を使うことで、QDocに派生プロジェクトをサポートさせることもできます。つまり、QDocはプロジェクトのドキュメントにQtオンラインドキュメントの要素へのリンクを生成することができます。派生プロジェクトのサポート」を参照してください。

有効な設定変数名には、大文字と小文字、数字、アンダースコア '_' を含めることができます。

設定変数の値は、'='か'+='のどちらかを使って設定することができます。違いは、'='が前の値を上書きするのに対し、'+='は現在の値に新しい値を追加することである。

いくつかの設定変数の値は、文字列のリストとして解釈されます： sourcedirsのように文字列のリストとして解釈されるものもあれば、1つの文字列として扱われるものもあります。値文字列を二重引用符で囲むことは任意ですが、それを含めると、値文字列の中で '=' や ' "' のような特殊文字を使うことができます。のような特殊文字を使用することができます：

HTML.postheader = "<a href=\"index.html\">Home</a>"

エントリーが何行にもわたる場合は、最後の行を除くすべての行末にバックスラッシュを使用します：

sourcedirs = kernel tools widgets

これは次のように書くことができる：

sourcedirs = kernel \
             tools \
             widgets

値が複数の行にまたがっているが、1つの文字列として解釈される場合、行はスペースで連結される。

設定値の展開

QDocは設定ファイル内の環境変数の展開をサポートしています。例えば、Qtモジュールは環境変数QT_INSTALL_DOCSに依存して、すべてのQtモジュール・ドキュメント・プロジェクトに関連する定義を含めます：

include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)

展開する変数の先頭には '$' を付けます。展開する変数の先頭には'$'が付きます。値文字列の中でリテラル文字'$'を使用するには、バックスラッシュでエスケープしてください。

QDoc 6.0以降、値は他の設定変数からも展開できます。$variable 構文に加えて、${variable} 構文も有効です。後者では、変数名を空白や変数以外の文字で区切る必要がなくなります。例えば

baseurl = https://doc.qt.io/
...
url = ${baseurl}qtcreator

ターゲット変数が文字列のリストを参照する場合、それらは展開された値で空白を使って連結される：

vars = foo \
       bar \
       baz

items = "Items: $vars"          # Expands to "Items: foo bar baz"

文字列リストの結合に使用する文字を制御することも可能です：

items = "Items: ${vars,|}"      # Expands to "Items: foo|bar|baz"
items = "Items: ${vars,,}"      # Expands to "Items: foo,bar,baz"
items = "Items: ${vars,}"       # Expands to "Items: foobarbaz"

展開処理はすべての変数を読み込んだ後に行われるため、定義順は関係ありません。

環境変数の展開

環境変数を展開する場合、${variable} 構文は$variable 構文と動作が異なります。前者は変数の内容を構成ファイルの一部として解析されるように展開しますが、後者は単に現在の構成変数の値として割り当てます。これは、環境変数が空白で区切られた要素のリストや、QDocが認識する他の書式を含んでいる場合に意味を持ちます。

たとえば、環境変数SRCDIRS の値が"../src/a ../src/b" の場合、次のようになります。

sourcedirs  = $SRCDIRS      # Fail - value is interpreted as a single path.
sourcedirs  = ${SRCDIRS}    # Ok - whitespace is used as a delimiter.

設定変数

変数リスト

• を定義します。
• 依存
• exampledirs
• examples
• examplesインストールパス
• examples.ファイル拡張子
• 除外ファイル
• 除外ファイル
• 画像
• 虚偽
• ヘッダディレクトリ
• ヘッダー
• ヘッダー.ファイル拡張子
• HTML.フッター
• HTML.ポストヘッダ
• HTML.スタイル
• インクルードパス
• 無視語
• を無視します。
• イメージファイル
• インデックス
• 言語
• 位置情報
• マクロ
• マニフェストメタ
• モジュールヘッダー
• ナビゲーション
• 出力ディレクトリ
• 出力フォーマット
• 出力接頭辞
• 出力接頭辞
• プロジェクト
• ソースディレクトリ
• ソース
• ソースファイル拡張子
• スプリアス
• タブサイズ
• url
• url.例
• バージョン
• バージョン
• 警告リミット

カテゴリー

• 一般的な設定変数
• フォーマット固有の設定変数

設定ファイルの例

• 最小構成ファイル:minimum.qdocconf
• Qt 設定ファイル:qtgui.qdocconf