トピックコマンド

トピック・コマンドは、QDoc にどのソース・コード要素を文書化するかを指示します。トピック・コマンドの中には、基本的なソース・コード要素に結びつかないドキュメント・ページを作成できるものもあります。

QDoc は QDoc コメントを処理するとき、まずソース・コード要素を指定するトピック・コマンドを探すことによって、コメントをソース・コード内の要素に結び付けようとします。トピック・コマンドがない場合、QDocはコメントの直後にあるソース・コード要素にコメントを接続しようとします。これらのどちらも実行できず、また、そのコメントに基礎となるソース・コード要素がないことを 示すトピック・コマンドもない場合（例： \page）、そのコメントは破棄されます。

ドキュメント化されるエンティティの名前は通常、トピック・コマンドの唯一の引数です。完全な名前を使用してください。引数に2番目のパラメー タがある場合もあります。例：\page.

\enum QComboBox::InsertPolicy

を参照してください。には、クラス修飾子を含む関数のシグネチャを使用します。

\fn void QGraphicsWidget::setWindowFlags(Qt::WindowFlags wFlags)

トピック・コマンドはコメント内のどこにでも表示できますが、独立した行にする必 要があります。トピック・コマンドをコメントの最初の行にするのは良い習慣です。引数が複数行にまたがる場合は、各行（最後の行を除く）がバックスラッシュで終わっていることを確認してください。さらに、QDocは括弧を数えます。つまり、'('に遭遇した場合、閉じる')までのすべてを引数とみなします。

トピックコマンドが異なる引数で繰り返される場合、両方のユニットに対して同じドキュメントが表示されます。

/*!
    \fn void PreviewWindow::setWindowFlags()
    \fn void ControllerWindow::setWindowFlags()

    Sets the widgets flags using the QWidget::setWindowFlags()
    function.

    Then runs through the available window flags, creating a text
    that contains the names of the flags that matches the flags
    parameter, displaying the text in the widgets text editor.
*/

PreviewWindow::setWindowFlags() 、ControllerWindow::setWindowFlags() 関数は同じドキュメントを取得します。

トピックコマンドによって生成されるファイルの命名法

を含む多くのトピック・コマンドでは、QDoc はドキュメンテーションを処理する際にファイルを生成します。

QDocは、ディスクに書き込む前に各ファイルの名前を正規化します。以下の操作が実行されます：

• 英数字以外の文字列はすべてハイフン '-' に置き換えられます。
• 大文字はすべて小文字に置き換えられます。
• 末尾のハイフンはすべて削除される。

たとえば、次のコマンドはthis-generates-a-file-and-writes-it-to-disk.html という名前のファイルを生成する：

\page this_generates_a_file_(and_writes_it_to_DISK)-.html

この例が示すように、コマンドでファイルに与えられた名前は、ディスクに書き込まれる実際のファイルの名前とは異なる場合がある。

生成ファイルの接頭辞と接尾辞

QDocがファイルを生成するとき、ファイルが文書化する要素に応じて、プレフィックス、サフィックス、またはその両方を追加することがあります。

下の表は、さまざまな要素に対する接頭辞と接尾辞を示しています。

\クラス

C++クラス、C/C++構造体、またはユニオンを文書化するためのコマンドです。引数は、クラスの完全な修飾名です。このコマンドは、クラスがパブリック API の一部であることを QDoc に伝え、詳細な説明を入力できます。

/*!
    \class QMap::iterator
    \inmodule QtCore

    \brief The QMap::iterator class provides an STL-style
    non-const iterator for QMap and QMultiMap.

    QMap features both \l{STL-style iterators} and
    \l{Java-style iterators}. The STL-style iterators ...
*/

指定されたクラスの HTML ドキュメントは、クラス名を小文字にし、ダブル・コロンの修飾子を '-' に置き換えて命名された.html ファイルに書き込まれます。例えば、QMap::iterator クラスのドキュメントはqmap-iterator.html に書き込まれます。

このファイ ルには、クラス・コメントから生成されたクラスの説明と、すべてのクラス・メンバの QDoc コメントから生成されたドキュメンテーション (クラスの型、プロパティ、関数、シグナル、およびスロットのリスト) が含まれます。

クラスの詳細な説明の他に、通常、"ag娱乐注册クラス・コメント "には、"ag娱乐注册モジュール・コマンド "と "ag娱乐注册簡単な説明 "が含まれます。非常に簡単な例を示します：

/*!
    \class PreviewWindow
    \inmodule CustomWidgets
    \brief The PreviewWindow class is a custom widget.
           displaying the names of its currently set
           window flags in a read-only text editor.

    \ingroup miscellaneous

    The PreviewWindow class inherits QWidget. The widget
    displays the names of its window flags set with the \l
    {function} {setWindowFlags()} function. It is also
    provided with a QPushButton that closes the window.

    ...

    \sa QWidget
*/

QDocがこのクラスをどのようにレンダリングするかは、style.css ファイルに依存します。

\列挙

C++のenum型を文書化するためのコマンドです。引数は列挙型の完全名です。

enum値は "enum "コメントで "enumvalue "コマンドを使用して文書化されます。enum値が "value "で文書化されていない場合、QDocは警告を発します。これらの警告は、QDocにenum値を文書化すべきではないことを伝えるためにenumomitvalueコマンドを使用して回避することができます。enumドキュメントは、enum型が定義されているクラス・リファレンス・ページ、ヘッダー・ファイル・ページ、またはネームスペース・ページに含まれます。例えば、Qt名前空間のenum型Corner ：

enum Corner {
    TopLeftCorner = 0x00000,
    TopRightCorner = 0x00001,
    BottomLeftCorner = 0x00002,
    BottomRightCorner = 0x00003
#if defined(QT3_SUPPORT) && !defined(Q_MOC_RUN)
    ,TopLeft = TopLeftCorner,
    TopRight = TopRightCorner,
    BottomLeft = BottomLeftCorner,
    BottomRight = BottomRightCorner
#endif
};

このenumはこのように文書化できます：

/*!
    \enum Qt::Corner

    This enum type specifies a corner in a rectangle:

    \value TopLeftCorner
           The top-left corner of the rectangle.
    \value TopRightCorner
           The top-right corner of the rectangle.
    \value BottomLeftCorner
           The bottom-left corner of the rectangle.
    \value BottomRightCorner
           The bottom-right corner of the rectangle.

    \omitvalue TopLeft
    \omitvalue TopRight
    \omitvalue BottomLeft
    \omitvalue BottomRight
               Bottom-right (omitted; not documented).
*/

名前空間修飾子が含まれていることに注意。

を参照してください。

\例

exampleコマンドは、サンプルを文書化するためのコマンドです。引数は、QDoc構成ファイルのexampledirs変数にリストされたパスの1つに対するサンプルの相対パスです。

ドキュメントページはmodulename-path-to-example.htmlに出力されます。QDocは、"noautolist "コマンドが使用されているか、設定変数url.examplesがプロジェク トに定義されていない限り、すべてのサンプルのソースファイルとイメージファイルのリ ストをページの最後に追加します。

例えば、exampledirsに$QTDIR/examples/widgets/imageviewer が含まれている場合、次のようになります。

/*!
    \example widgets/imageviewer
    \title ImageViewer Example
    \subtitle

    The example shows how to combine QLabel and QScrollArea
    to display an image.

    ...
*/

も参照してください： \を 参照してください。

\外部ページ

外部URLにタイトルを割り当てるコマンドです。

/*!
    \externalpage http://doc.qt.io/
    \title Qt Documentation Site
*/

これにより、ドキュメントに外部ページへのリンクを含めることができます：

/*!
    At the \l {Qt Documentation Site} you can find the latest
    documentation for Qt, Qt Creator, the Qt SDK and much more.
*/

を使わずに同じ結果を得るには、文書にアドレスをハードコードする必要があります：

/*!
    At the \l {http://doc.qt.io/}{Qt Documentation Site}
    you can find the latest documentation for Qt, Qt Creator, the Qt SDK
    and much more.
*/

を使用せずに同じ結果を得るには、文書にアドレスをハードコードする必要があります。もしアドレスが変更されたとしても、 \externalpage コマンドの引数を変更するだけで済みます。

\fn（関数）

関数にドキュメントを作成するためのコマンドです。引数は関数のシグネチャで、テンプレート引数(もしあれば)、戻り値型、const-ness、 型を持つ正式引数のリストを含みます。指定された関数が存在しない場合、QDocは警告を発します。

このコマンドはauto 、関数の型として受け付けます。特定の状況では、関数の実際の型の代わりにautoを使用することが望ましいかもしれません。auto このような場合、autoキーワードを使用せずに定義された型でも、作者が明示的にこれを行うことができます。

QDocバージョン6.0以降では、ヘッダーで明示的に宣言されていないが、コンパイラが暗黙的に 生成するクラス・メンバ(デフォルト・コンストラクタとデストラクタ、コピー・コンストラクタと 移動コピー・コンストラクタ、代入演算子、移動代入演算子)をドキュメント化するために、 \fnコマンドを使用することができます。

隠しフレンドを文書化する場合、関数名の前にクラス名を付ける必要があります。例えば

class Foo {
   ...
   friend bool operator==(const Foo&, const Foo&) { ... }
   ...
}

コマンドは"\fn Foo::operator==(const Foo&, const Foo&)" と書くべきで、自由関数"\fn operator==(const Foo&, const Foo&)" とは書かない。

そうしないと、QDocは関数を解決できないと文句を言うでしょう。

/*!
    \fn bool QToolBar::isAreaAllowed(Qt::ToolBarArea area) const

    Returns \c true if this toolbar is dockable in the given
    \a area; otherwise returns \c false.
*/

を参照してください。

\グループ

groupコマンドは、指定されたグループに属するクラス、ページ、またはその他のエンティティをリストする個別のページを作成します。引数はグループ名です。

クラスは、"ingroup "コマンドを使用してグループに含まれます。概要ページも同じコマンドを使用してグループに関連付けることができますが、概要ページのリストは ˶generatelistコマンドを使用して明示的に要求する必要があります。

(下の例を参照) ￤groupコマンドの後には通常、￤titleコマンドとグループの短い紹介文が続きます。グループのHTMLページは、<lower-case-group-name>.htmlという名前の.html ファイルに書き込まれます。

グループ内の各エンティティは、リンクとしてリストされ（ページタイトルまたはクラス名を使用）、その後にエンティティのドキュメンテーションにある" \brief"コマンドからの説明が続きます。

/*!
    \group io
    \title Input/Output and Networking
*/

QDocはグループ・ページio.html を生成します。

グループに関連する概要ページは、related 引数を指定した\generatelistコマンドを使用して明示的にリストする必要があることに注意してください。

/*!
    \group architecture

    \title Architecture

    These documents describe aspects of Qt's architecture
    and design, including overviews of core Qt features and
    technologies.

    \generatelist{related}
*/

(1)QDocがグループページを生成する。

\ヘッダーファイル

ヘッダーファイルで宣言されているが、名前空間では宣言されていないグローバル関数、型、 マクロを文書化するためのコマンドです。引数はヘッダーファイルの名前です。HTMLページは、ヘッダーファイル引数から構築された.html ファイルに書き込まれます。

ドキュメント化されるヘッダー・ファイルで宣言されている関数、型、マクロのドキュメントは、"relates "コマンドを使用してヘッダー・ファイル・ページに含まれます。

引数がヘッダファイルとして存在しない場合、"headerfile "コマン ドはヘッダファイルのドキュメントページを作成します。

/*!
   \headerfile <QtAlgorithms>

   \title Generic Algorithms

   \brief The <QtAlgorithms> header file provides
    generic template-based algorithms.

   Qt provides a number of global template functions in \c
   <QtAlgorithms> that work on containers and perform
   well-know algorithms.
*/

QDocはヘッダーファイルページ、qtalgorithms.html を生成します。

を参照してください。

\マクロ

C++マクロを文書化するためのコマンドです。引数は、Q_ASSERT() のような関数のようなマクロ、Q_PROPERTY() のような宣言スタイルのマクロ、Q_OBJECT のような括弧のないマクロの3つのスタイルのうちの1つのマクロです。

マクロ・コメントには、マクロ・コメントをクラス、ヘッダー・ファイル、またはネームスペースにアタッチするrelatesコマンドを含める必要があります。さもないと、ドキュメントが失われます。

\モジュール

コマンドの引数で指定されたモジュールに属するクラスをリストするページを作成します。classコマンドのコメントに "indmodule "コマンドを含めることで、そのモジュールに含まれるクラスが表示されます。

を指定すると、そのモジュールに属するクラスが一覧表示されます。各クラスは、クラス・リファレンス・ページへのリンクの後に、そのクラスの ㊟コマンドのテキストが続きます。例えば

/*!
    \module QtNetwork

    \title Qt Network Module

    \brief Contains classes for writing TCP/IP clients and servers.

    The network module provides classes to make network
    programming easier and portable. It offers both
    high-level classes such as QNetworkAccessManager that
    implements application-level protocols, and
    lower-level classes such as QTcpSocket, QTcpServer, and
    QUdpSocket.
*/

最後に自動生成されるクラスのリストを省略するには、ここで ˶noautolistコマンドを使用できます。

関連項目

\名前空間

このコマンドは、引数として指定された C++ 名前空間の内容を文書化するためのものです。QDoc が名前空間に対して生成する参照ページは、C++ クラスに対して生成する参照ページと似ています。

/*!
    \namespace Qt

    \brief Contains miscellaneous identifiers used throughout the Qt library.
*/

C++ では、特定の名前空間を複数のモジュールで使用することができますが、異なるモジュールの C++ 要素が同じ名前空間で宣言されている場合、その名前空間自体は 1 つのモジュールでのみドキュメント化する必要があることに注意してください。例えば、上の例の名前空間 Qt には、QtCore とQtGui の両方の型と関数が含まれています が、namespace コマンドでドキュメント化されるのはQtCore のみです。

\ページ

namespaceコマンドで文書化されるのは、 のみです。

(このコマンドは、QDocがページを保存するファイル名を表す引数を1つ受け取ります)。

ページ・タイトルは、"\title"コマンドで設定します。

/*!
   \page aboutqt.html

   \title About Qt

   Qt is a C++ toolkit for cross-platform GUI
   application development. Qt provides single-source
   portability across Microsoft Windows, macOS, Linux,
   and all major commercial Unix variants.

   Qt provides application developers with all the
   functionality needed to build applications with
   state-of-the-art graphical user interfaces. Qt is fully
   object-oriented, easily extensible, and allows true
   component programming.

   ...
*/

QDocはこのページをaboutqt.html 。

\プロパティ

Qtプロパティを文書化するためのコマンドです。引数は完全なプロパティ名です。

プロパティはQ_PROPERTY() マクロを使って定義します。このマクロは、プロパティの名前と set、reset、get 関数を引数として取ります。

Q_PROPERTY(QString state READ state WRITE setState)

set、reset、get関数は文書化する必要はなく、プロパティを文書化すれば十分です。QDocは、プロパティのドキュメントに表示されるアクセス関数のリストを生成し、それはプロパティを定義するクラスのドキュメントに配置されます。

QDocは、プロパティのドキュメントに表示されるアクセス関数のリストを生成します。このコマンドは、プロパティを定義するクラスのドキュメンテーションにあります。このコマンドは、説明のためのルールとして、[変数]コマンドと同じルールに従います。

/*!
    \property QPushButton::flat
    \brief Whether the border is disabled.

    This property's default is false.
*/

\プロパティ

QMLタイプにアタッチされるQMLプロパティを記述するためのコマンドです。Attached Propertiesを参照してください。引数は行の残りの部分です。最初にプロパティ・タイプを指定し、その後にプロパティを宣言する QML タイプ名、:: 修飾子、最後にプロパティ名を指定します。

例えば、ListView タイプに対して、isCurrentItem という名前のブーリアン QML アタッチド・プロパティを文書化する場合：

/*!
    \qmlattachedproperty bool ListView::isCurrentItem

    This attached property is \c true if this delegate is the current
    item; otherwise false.

    It is attached to each instance of the delegate.

    This property may be used to adjust the appearance of the current
    item, for example:

    \snippet doc/src/snippets/declarative/listview/listview.qml isCurrentItem
*/

QDoc はこのアタッチド・プロパティをListView タイプの QML 参照ページに記述します。

\を指定します。

アタッチ可能なシグナルを文書化するためのコマンドです。このコマン ドは、"attachedsignal"コマンドと同じように使用します。

引数は行の残りの部分です。引数にはシグナルが宣言されている QML タイプ名、:: 修飾子、最後にシグナル名を指定します。例えば、GridView 要素にadd() という名前の QMLアタッチド・シグナルがある場合、次のように記述します：

/*!
    \qmlattachedsignal GridView::add()
    This attached signal is emitted immediately after an item is added to the view.
*/

QDocでは、このドキュメントをGridView 要素のQML参照ページに記載しています。

\QML

QMLの値タイプを文書化するためのコマンドです。このコマンドは、型名を唯一の引数として受け取ります。

\このコマンドは、型名を唯一の引数として受け取ります。唯一の違いは、型にQML 値型としてのタイトルが付けられる (そしてグループ化される) ことです。

\QML class

このコマンドは非推奨です。代わりに ⅳqmltype を使用してください。

\Ȃqmlmethod

QMLメソッドを文書化するためのコマンドです。引数には、戻り値の型やパラメータ名と型を含む完全なメソッド・シグニチャを指定します。

/*!
    \qmlmethod void TextInput::select(int start, int end)

    Causes the text from \a start to \a end to be selected.

    If either start or end is out of range, the selection is not changed.

    After having called this, selectionStart will become the lesser, and
    selectionEnd the greater (regardless of the order passed to this method).

   \sa selectionStart, selectionEnd
*/

QDoc では、TextInput要素の要素リファレンス・ページにこのドキュメントが含まれています。

\qmltype

QMLタイプを文書化するためのコマンドです。このコマンドには引数が 1 つあり、QML タイプの名前を指定します。

QML型に同等のC++クラスがある場合は、そのクラスを \nativetypecontextコマンドで指定できます。

この型が属する QML モジュールを文書化するコマンドです。このコマンドに渡される引数は、ドキュメント化された ￤inqmlmoduleページと一致しなければなりません。

/*!
    \qmltype Transform
    \nativetype QGraphicsTransform
    \inqmlmodule QtQuick

    \brief Provides a way to build advanced transformations on Items.

    The Transform element is a base type which cannot be
    instantiated directly.
*/

この場合、"type"のコメントには \nativetypeを追加して、Transform が C++ クラスQGraphicsTransform に対応する QML であることを指定します。すべてのQMLタイプは新しいので、♪qmltypeコメントには常に♪sinceコマン ドを含めるべきです。また、簡単な説明も含める必要があります。QML型がQML型グループのメンバである場合、♪qmltypeコメントには1つ以上の♪ingroupコマン ドを含める必要があります。

\プロパティ

QMLプロパティを文書化するコマンドです。引数は行の残りの部分です。引数のテキストは、プロパティ・タイプ、QMLタイプ名、:: 修飾子、最後にプロパティ名となります。QML タイプがTranslate で、x という名前の QML プロパティがあり、そのプロパティのタイプがreal である場合、そのプロパティのための \qmlproperty は次のようになります：

/*!
    \qmlproperty real Translate::x

    The translation along the X axis.
*/

QDoc はこの QML プロパティをTranslate タイプの QML 参照ページに含めます。

QML プロパティが列挙型である場合、またはフラグのビット単位の組み合わせを保持する場 合、許容される値を文書化するために\valueコマンドを使用できます。

QDocは、QMLモジュール識別子を含む完全修飾されたプロパティ名も受け付けます：

\qmlproperty bool QtQuick.Controls::Button::highlighted

指定された場合、モジュール識別子(上記、QtQuick.Controls)は、関連する ￤qmltypeドキュメントの￤inqmlmoduleコマンドに渡された値と一致しなけれ ばなりません。プロパティが属するQMLタイプの名前が、ドキュメンテーション・プロジェクト内のすべてのタイプで一意である場合は、モジュール識別子を省略できます。

\モジュール識別子

QMLシグナルを文書化するためのコマンドです。引数は行の残りの部分です。引数には、シグナルが宣言されている QML タイプ、:: 修飾子、そして最後にシグナル名を指定します。clicked() という名前のQMLシグナルがあった場合、そのドキュメントは次のようになります：

/*!
    \qmlsignal MouseArea::clicked(MouseEvent mouse)

    This signal is emitted when there is a click. A click is defined as a
    press followed by a release, both inside the MouseArea.
*/

QDocはこのドキュメントをMouseArea 型のQMLリファレンスページに含んでいます。

\を指定します。

QML モジュール・ページを作成するには、\qmlmodule コマンドを使用します。QML モジュール・ページとは、QML タイプや関連する資料を集めたものです。このコマンドはオプションで<VERSION> 番号の引数を取り、group-command に似ています。

QMLの型は、その型を文書化したコメントブロックの中にあるモジュールに 関連付けられます。モジュール名と2つのコロン(::)の接頭辞を使うことで、QMLモジュールのどのメンバ ーにもリンクすることができます。

/*!
    A link to the TabWidget of the UI Component is \l {UIComponent::TabWidget}.
*/

QDocはモジュールの全メンバーをリストしたページを生成します。

/*!
    \qmlmodule ClickableComponents

    This is a list of the Clickable Components set. A Clickable component
    responds to a \c clicked() event.
*/

\モジュール

あるQMLタイプが特定のQMLモジュールのインポート下で使用可能であることを示すた めには、"inqmltype "トピックに "inqmlmodule "コマンドを挿入します。このコマンドは、バージョン番号を除いたモジュール(インポート)名だけを引数に取ります。

このQMLモジュール名は、(ⅳqmlmoduleコマンド)でドキュメント化されたQMLモジュー ルと一致しなければなりません。

/*!
    \qmltype ClickableButton
    \inqmlmodule ClickableComponents

    A clickable button that responds to the \c click() event.
*/

QDocはQMLタイプ・リファレンス・ページの一番上の表にImport <qmlmodule>という行を出力します。

QMLタイプにリンクする場合、リンク先にQMLモジュールの識別子が表示されることがあります。例えば

\l {ClickableComponents::}{ClickableButton}

ClickableButtonをリンクテキストとして、タイプ参照ページへのリンク。

\例

Qt6.8以降、"instantiates "コマンドは非推奨です。代わりに \nativetypeを使用してください。

\ネイティブ型

を使用する必要があります。 \qmltypeトピック・コマンドと併用する必要があります。このコマンドは引数として C++ クラスを取ります。QDoc がその C++ クラスを見つけられない場合は、警告を発します。このコマンドは Qt 6.8 で導入されました。

このコマンドは Qt 6.8 で導入されました。これにより、QML タイプのドキュメントに生成される requisites ブロックに "In C++" エントリが含まれるようになります。C++ クラスには対応する "In QML" エントリがあります。

つのQML型は1つのネイティブ型しか持つことができません。QDocは再定義を行うと警告を発します。しかし、複数のQML型は同じC++クラスをネイティブ型として持つことができます。C++クラスのドキュメントには、QMLの対応する全ての型のリストが記載されます。

/*!
    \qmltype Transform
    \nativetype QGraphicsTransform
    \inqmlmodule QtQuick

    \brief Provides a way to build advanced transformations on Items.

    The Transform element is a base type which cannot be
    instantiated directly.
*/

ここでは、Transform が C++ でQGraphicsTransform と呼ばれることを指定するために、"integrate"トピックに "integratenativetype "が含まれています。

\typealias

このトピックでは、C++でTransformが と呼ばれることを指定するために、\nativetypeが含まれています：

class Foo
{
public:
    using ptr = void*;
// ...
}

これは

/*!
    \typealias Foo::ptr
*/

typealiasコマンドはQDoc 5.15で導入されました。

を参照してください。

\を参照してください。

C++のtypedefを文書化するためのコマンドです。引数は typedef の名前です。この型定義は、その型定義が宣言されているクラス、名前空間、またはヘッダー・ ファイルの参照ドキュメントに含まれます。をクラス、名前空間、またはヘッダー・ファイルと関連付けるには、"relates "コマン ドを "typedef "コメントに含める必要があります。

/*!
    \typedef QObjectList
    \relates QObject

    Synonym for QList<QObject>.
*/

他の typedef は、それを定義しているクラスの参照ページにあります。

/*!
    \typedef QList::Iterator

    Qt-style synonym for QList::iterator.
*/

typealiasも参照。

\変数

クラス・メンバ変数または定数を文書化するためのコマンドです。引数は変数名または定数名です。(例:recommend.recommend.recommend.recommend.recommend.)QDocは、"brief "コマンドのテキストに基づいてドキュメントを生成します。

このドキュメントは、関連するクラス、ヘッダーファイル、またはネームスペースのドキュメンテーションに配置されます。

メンバ変数の場合

/*!
    \variable QStyleOption::palette
    \brief The palette that should be used when painting
           the control
*/

メンバ変数の場合: 定数も、" \variable" コマンドでドキュメント化できます。例えば、QTreeWidgetItem クラスにType とUserType 定数があるとします：

enum { Type = 0, UserType = 1000 };

これらの定数に対して、 \variable コマンドはこのように使用できます：

/*!
    \variable QTreeWidgetItem::Type

    The default type for tree widget items.

    \sa UserType, type()
*/

/*!
    \variable QTreeWidgetItem::UserType

    The minimum value for custom types. Values below
    UserType are reserved by Qt.

    \sa Type, type()
*/