これらのコマンドは、ドキュメントの視覚的な外観やドキュメントの生成プロセスに関連する雑多な機能を提供します。

\注釈リスト

annotatedlistコマンドは、グループのメンバーのリストに展開され、各メンバーは簡単なテ キストと共にリストされます。このコマンドを実行すると、グループのメンバのリストが展開され、各メンバが簡単なテ キストとともに表示されます：

/*!
   ...
   \section1 Drag and Drop Classes

   These classes deal with drag and drop and the necessary mime type
   encoding and decoding.

   \annotatedlist draganddrop
*/

これは、draganddropグループ内のすべての C++ クラスまたは QML 型のリストを生成します。draganddropグループに含まれるC++クラスまたはQMLタイプは、"\ingroup draganddrop "が"˶ class "または"˶qmltype "コメントに含まれます。

グループ・メンバーは、ユーザーから見える名前またはタイトルに基づいて昇順にソートされます。QDoc 6.8以降では、"annotatedlist "と "annotatedlist "もカスタムソートに対応しています。 \generatelistもカスタムソートに対応しています。

参照 \generatelistおよびSorting group membersも参照してください。

\qtcmakepackage

クラスとネームスペースに CMake パッケージ情報を追加するには、∕qtcmakepackage コマンドを使用します。この情報は、クラスやネームスペースのドキュメント・ページの上部にある表に表示されます。例えば

/*!
    \namespace Foo
    \inheaderfile Bar
    \qtcmakepackage Baz
    \brief A namespace.

    ...
*/

QDoc は次のように出力します。

Foo 名前空間

名前空間。詳細...

ヘッダ：	#define <バー
CMakeで	find_package(Qt6 必須コンポーネント Baz)

\qtcmaketargetitem

クラスと名前空間に追加される CMaketarget_link_libraries 情報の項目部分をオーバーライドするには、 ˶qtcmaketargetitem コマンドを使用します。このコマンドは、"item "コマンドと "item"コマンドを併用する必要があります。

また、「 index.index.index.index.index.index」も参照してください 。｝

\生成リスト

を使用してグループ化された文書エンティティへのリンクのリスト、または以下に挙 げる引数のいずれかに一致するエンティティへのリンクのリストに展開します。Qt Reference Documentation の例：

/*!
   \page classes.html
   \title All Classes

   For a shorter list that only includes the most
   frequently used classes, see \l{Qt's Main Classes}.

   \generatelist classes Q
*/

これはAll Classesページを生成します。このコマンドは以下の引数を受け付けます：

<group-name>

唯一の引数としてグループ名を指定すると、QDoc は\ingroup <group-name> コマンドを使用するすべてのエンティティを一覧表示します。

グループ・メンバーの並べ替え

グループ・メンバーのリストを生成する場合、ユーザーから見える名前またはタイトルに基づいて昇順にソートされます。QDoc 6.8以降、デフォルトのソート順を変更することができます：

\generatelist [descending] changelogs

変更履歴グループが異なるバージョンの変更の詳細ページで構成されていると仮定すると、これは降順（新しいバージョンが最初）でリストを生成します。

ソートキー

QDoc 6.8以降、カスタムソートキーを1つ以上のグループメンバーに割り当てることができます。 \metaコマンドを使って、1つ以上のグループメンバーにカスタムソートキーを割り当てることができます：

\meta sortkey {sort key}

ソート（昇順または降順）は、ユーザーから見えるタイトルではなく、これらのキーに基づいて行われます。

annotatedclasses

annotatedclasses 引数は、すべてのクラスの名前と各クラスの説明を含むテーブルを提供します。各クラス名は、そのクラスのリファレンス・ドキュメントへのリンクです。例えば

C++のクラスは、"︙class "コマンドで文書化されます。クラスに対する注釈は、クラス・コメント の \briefコマンドの引数から取られます。

annotatedexamples

annotatedexamples 引数は、すべての例のタイトルと各例の説明を含む一連の表として、すべての例の完全なリストを提供します。各タイトルは、例のドキュメントへのリンクです。

モジュールがnavigation.landingpage設定変数を定義していれば、（文書化された例を持っている）各モジュールのための別々のテーブルが生成されます。landingpage変数は、各テーブルの前にあるヘッダーのタイトルとして使われます。

annotatedattributions

annotatedattributions 引数は、すべての属性のタイトルと各属性の説明を含むテーブルのセットとして、すべての属性の完全なリストを提供します。各タイトルは、属性のページへのリンクです。

モジュールがnavigation.landingpage設定変数を定義していれば、（属性を持つ）各モジュールのための別々のテーブルが生成されます。landingpage変数は各テーブルの前にあるヘッダーのタイトルとして使われます。

classes <prefix>

classes 引数はクラスの完全なアルファベット順リストを提供します。2番目の引数、<prefix> は、クラス名の共通接頭辞です。クラス名は、共通接頭辞に続く文字でソートされます。例えば、Qt クラスの共通接頭辞はQ です。共通接頭辞引数は省略可能です。共通接頭辞を省略すると、クラス名は最初の文字でソートされます。

各クラス名は、そのクラスのリファレンス・ドキュメントへのリンクになります。このコマンドは、この方法でAll Classesページを生成するために使用されます：

/*!
    \page classes.html
    \title All Classes
    \ingroup classlists

    \brief Alphabetical list of classes.

    This is a list of all Qt classes. For classes that
    have been deprecated, see the \l{Obsolete Classes}
    list.

    \generatelist classes Q
*/

C++ クラスは、[クラス]コマンドでドキュメント化されます。

classesbymodule

この引数を使用する場合は、クラスがリストされるモジュールを指定する第 2 引数が必要です。QDocはこれらのクラスを含む表を生成します。QDocは、それらのクラスを含む表を生成します。

例えば、このコマンドはモジュール・ページで以下のように使用できます：

/*!
    \page phonon-module.html
    \module Phonon
    \title Phonon Module
    \ingroup modules

    \brief Contains namespaces and classes for multimedia functionality.

    \generatelist{classesbymodule Phonon}

    ...
*/

指定されたモジュールのメンバである各クラスは、その ￤クラスのコメントに￤inmoduleコマンドを付 けなければなりません。

qmltypesbymodule

classesbymodule と似ていますが、第2引数で指定された QML モジュールの QML 型(QML 値型を除く)をリストするために使用されます。

qmlvaluetypesbymodule

qmltypesbymodule と似ていますが、代わりにQMLの値型を列挙します。

functionindex

functionindex 引数は、文書化されているすべてのメンバ関数の完全なアルファベット順のリストを提供します。通常、この引数はQt関数のインデックスページを生成するためだけに使用されます：

/*!
    \page functions.html
    \title All Functions
    \ingroup funclists

    \brief All documented Qt functions listed alphabetically with a
    link to where each one is declared.

    This is the list of all documented member functions and global
    functions in the Qt API. Each function has a link to the
    class or header file where it is declared and documented.

    \generatelist functionindex
*/

legalese

legalese 引数は、QDoc に現在のドキュメント・プロジェクトのライセンスのリストを生成するよう指示します。各ライセンスは "legalese "コマンドを使用して識別されます。

overviews

overviews 引数は、QDoc に、すべての ⽋⽋グループページの内容を連結してリストを⽣成するよう指示するために使⽤します。Qtはこの方法で概要ページを生成します：

/*!
    \page overviews.html

    \title All Overviews and HOWTOs

    \generatelist overviews
*/

attributions

attributions 引数は、QDocにドキュメントの属性リストを生成するように指示するために使用します。

related

related 引数は、指定されたグループに関連するすべての概要の一覧を表示するために、"group "コマンドと "group "コマンドと組み合わせて使用します。例えば、Programming with Qtページのページはこのように生成されます：

/*!
    \group qt-basic-concepts
    \title Programming with Qt

    \brief The basic architecture of the Qt cross-platform application and UI framework.

    Qt is a cross-platform application and UI framework for
    writing web-enabled applications for desktop, mobile, and
    embedded operating systems. This page contains links to
    articles and overviews explaining key components and
    techniuqes used in Qt development.

    \generatelist {related}
*/

このグループページにリストされている各ページには、コマンドが含まれています：

\ingroup qt-basic-concepts

参照 \annotatedlist.

\もし

ifコマンドとそれに対応するendifコマンドは、コマンドの引数で指定された条件が真である場合にのみ、QDocコメントの一部を含めます。

コマンドは行の残りの部分を読み取り、C++の#if文として解析します。

/*!
   \if defined(opensourceedition)

   \note This edition is for the development of
   \l{Qt Open Source Edition} {Free and Open Source}
   software only; see \l{Qt Commercial Editions}.

   \endif
*/

このQDocコメントは、opensourceedition プリプロセッサ・シンボルが定義されていて、QDocに#ifdefと#endif内のコードを処理させるために設定ファイルのdefines変数で指定されている場合にのみレンダリングされます：

defines = opensourceedition

コマンドラインで手動でプリプロセッサ・シンボルを定義することもできます。詳細はdefines変数のドキュメントを参照してください。

endif、else、defines、falseも参照してください。

\endif

endifコマンドと対応するifコマンドは、endifコマンドの引数で指定された条件が真である場合に、QDocコメントの一部を含めます。

詳しくは、"if "コマンドのドキュメントを参照してください。

(2)QDocのコメント: QDocのコメントには、QDocのコメントが含まれます。

\else

else "コマンドは、"if"コマンドの条件が "false "である場合の代替案を指定します。

elseはif...endifの中でしか使えませんが、選択肢が2つしかない場合に便利です。

\インクルード

includeコマンドは、第1引数で指定されたファイルの全部または一部をQDoc入力ストリー ムに送り、QDocコメントスニペットとして処理します。

このコマンドは、コマンドやテキストのスニペットをドキュメントの複数の場所で使用する場合に便利です。文書にスニペットを挿入したい場合は、どこでもincludeコマンドを使用してください。インクルードするスニペットを含むファイルは、sourcedirsまたはexampledirsQDoc 設定変数にリストされているパスの下になければなりません。QDocが解析するソース・ファイル（またはincludeコマンドを使用するソース・ファイル）でも、その他のテキスト・ファイルでもかまいません。QDocによって解析されることを意図していない別のファイルにスニペットを保存するには、sources.fileextensionsにリストされていないファイル拡張子を使用します。例えば、.qdocinc.

コマンドには1つ以上の引数を指定できます。最初の引数は常にファイル名です。ファイルの内容はQDoc入力でなければなりません。言い換えると、QDocコマンドとテキストのシーケンスですが、QDocコメント/*! ...*/ 区切りは含まれません。名前付きファイル全体を含めたい場合は、2番目の引数を空にしてください。ファイルの一部分のみをインクルードしたい場合は、以下の2つの引数の形式を参照してください。以下は1つの引数の例である：

/*!
    \page corefeatures.html
    \title Core Features

    \include examples/signalandslots.qdocinc
    \include examples/objectmodel.qdocinc
    \include examples/layoutmanagement.qdocinc
*/

\includeファイル名 snippet-identifier

ドキュメントの複数の場所で使いたいQDocインクルード・スニペットごとに.qdocinc 。インクルードするスニペットが複数ある場合は、それらをすべて1つのファイルにまとめて、それぞれを：

//! [snippet-id1]

QDoc commands and text...

//! [snippet-id1]

//! [snippet-id2]

More QDoc commands and text...

//! [snippet-id2]

そうすれば、2つの引数を持つコマンドを使うことができます：

\include examples/signalandslots.qdocinc snippet-id2
\include examples/objectmodel.qdocinc another-snippet-id

QDocコマンドのシーケンスと、第2引数と同じ名前の2つのタグの間に見つかったテキストがQDoc入力ストリームに送られます。スニペットを入れ子にすることもできます。

追加引数

QDoc 6.3以降、includeコマンドに渡される追加引数は、インクルードされるコンテンツに文字列を挿入するために使用されます。コンテンツ内の特定の場所に文字列を挿入するには、バックスラッシュの後に数字(1..9)を追加します。数字は引数リストの順番に対応する。引数を中かっこで囲むと、QDocが期待通りに空白文字を含む引数全体をレンダリングします。

例えば、以下のスニペットがファイルincludes.qdocinc ：

//! [usage]
To enable \e{\1}, select \uicontrol {\2} > \uicontrol Enable.
//! [usage]

そして、以下のinclude行：

\include includes.qdocinc {usage} {detailed output} {Verbose}

レンダリング

詳細出力を有効にするには、Verbose >Enable を選択します。

\メタ

メタデータを文書に追加するには、"meta "コマンドを使用します。このコマンドには2つの引数があります：最初の引数はメタデータの属性名で、2番目の引数は属性の値です。各引数は、この例のように中かっこで囲む必要があります：

/*!
    \example demos/coffee
    \title Coffee Machine
    \brief A Qt Quick application with a state-based custom user interface.

    \meta {tags} {quick,embedded,states,touch}
    \meta {category} {Application Examples}
*/

多くのメタデータ属性は特定の目的を持っています：

メタデータの例

メタデータ・コマンドのもう1つの使い方は、メタデータ(タグ)をサンプル・ドキュメンテーションに含めることです。デフォルトでは、QDocは例のタイトルとモジュール名に基づいて例のタグを生成します。これらのタグはQt CreatorのWelcomeモードで表示され、ユーザーがサンプルリストをナビゲートするのに役立ちます。

追加のタグは、\meta {tag} {tag1} または\meta {tags} {tag1,[tag2,...]} で作成できます。例えば

/*!
    \example helloworld
    \title Hello World Example
    \meta {tags} {tutorial,basic}
*/

この場合、次のようなタグになります：tutorial,basic,hello,world。exampleのような一般的な単語は無視されます。

例の除外

サンプルを壊れたとマークすると、生成されたマニフェストファイルから除外され、Qt Creator の Welcome モードから効果的に除外されます。

\meta {tag} {broken}

例のインストールパス

mod_meta コマンドと引数installpath を組み合わせると、インストールされるサンプルの場所が指定されます。この値は、examplesinstallpath 構成変数を使用して設定された値を上書きします。

/*!
    \example helloworld
    \title Hello World Example
    \meta {installpath} {tutorials}
*/

examplesinstallpathも参照してください。

ステータス

mod_meta コマンドのstatus 引数を指定すると、カスタムステータスが追加されます。この説明は、タイプ参照ページの上部にある表に表示されます。

/*!
    \class QNativeInterface::QAndroidApplication
    \meta {status} {Android-specific}
*/

ステータス関連のコマンドも参照してください。

\ノオートリスト

C++ または QML モジュール・ページの下部に自動的に生成される C++ クラスまたは QML 型の注釈付きリストは、クラスまたは型が手動でリストされているため省略する必要があります。このコマンドは、グループ・メンバーが手動でリストされている場合に、グループ・ メンバーのリストを省略するために\groupコマンドと一緒に使用することもできます。

このコマンドは独立した行に記述する必要があります。例についてはQt Quick Controls QML Types を参照してください。このページはqtquickcontrols2-qmlmodule.qdoc から生成されています。そこにはQtQuick.Controls モジュール用の\qmlmodule コマンドを含む QDoc コメントがあります。同じコメントには、自動リスト生成を無効にするための\noautolist コマンドと、ドキュメントの特定のセクションにある QML タイプをリストアップするための\generatelistコマンドが含まれています。

このコマンドはQDoc 5.6で導入されました。

Qt 5.10以降、このコマンドはサンプル・ドキュメントにも適用でき るようになり、サンプル・プロジェクトに属するファイルやイメージの自動 生成リストを省略できるようになりました。

\を省略します。

このコマンドは、サンプル・プロジェクトに属する自動生成されたファ イルとイメージのリストを省略させます。例えば

/*!
    \table
    \row
        \li Basic Widgets
        \li Basic GUI widgets such as buttons, comboboxes
           and scrollbars.

    \omit
    \row
        \li Component Model
        \li Interfaces and helper classes for the Qt
           Component Model.
    \endomit

    \row
        \li Database Classes
        \li Database related classes, e.g. for SQL databases.
    \endtable
*/

\raw（避けてください!）

rawコマンドとそれに対応するendrawコマンドは、生のマークアップ言語コードのブロックを区切ります。

このコマンドは、コードの形式を指定する引数を取ります。

QDocは、ユーザーによって指定された形式を生成する場合にのみ、指定されたコードを生成します。

例えば、" \raw HTML "は、QDocがHTMLドキュメントを生成するときにのみコードを生成します。

\シンクリスト

Ȃsincelistコマンドは、指定されたバージョンでドキュメント化されたAPIに新たに追加された内容の詳細な内訳に展開します。使用例

/*!
   \page newclasses68.html
   \title New Classes and Functions in 6.8
   \brief A comprehensive list of new classes and functions in 6.8.

   \sincelist 6.8
*/

\sincelistは1つの引数、バージョン文字列を取ります。この出力には、バージョン文字列と一致する"since " 句または "since "コマン ドでマークされたすべての機能が含まれます。

\ユニコード

unicodeコマンドは、任意のUnicode文字を文書に挿入することができます。

このコマンドは、文字を整数として指定する引数を取ります。デフォルトでは、'0x'または'0'の接頭辞が指定されない限り、基数10が仮定されます（それぞれ基数16と8用）。