物のグループ分け

グループ化コマンドは、クラスを定義済みのグループやモジュールに関連付けます。グループは、ドキュメント内で関連するクラスのリストを生成する際に使用され、モジュールはQtの構造を構成する要素です。

コマンド

\ingroup

\ingroup コマンドは、指定されたクラス、ページ、またはその他のエンティティが、関連するドキュメントの特定のグループに属することを示します。

1つのエンティティは、複数のグループに属することがあります。

\ingroup コマンドの引数はグループ名ですが、このコマンドは行の残りの部分を引数の一部として扱う点に注意してください。グループ名の後に改行を入れるようにしてください。

/*!
    \class QDir
    \brief The QDir class provides access to directory
           structures and their contents.

    \ingroup io
    ...
*/

QDir これにより、`QDir `クラスが`io `グループに追加されます。その後、例えば \annotatedlist 引数として `io` を指定したコマンドなどで作成されたリストに、` ` のエントリが表示されます。

QDocは、C++のクラス、名前空間、またはヘッダーのリファレンスページ上で、関連するグループへのリンクを自動的に生成します。例えば、上記のクラスQDirのドキュメントと、以下の \group ページがあるとします：

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

QDocは、QDir の参照ページに次のような記述を出力します：

• QDirは、入出力およびネットワーク機能の一部です。

HTML出力の場合、QDocはナビゲーションバー（ブレッドクラム）の一部として、グループページへのリンクも生成します。複数の\ingroup コマンドが使用されている場合、ドキュメント化された\group を参照している最初のものが選択されます。

関連項目 \group。

\inmodule

\inmodule コマンドは、クラスを、コマンドの引数で指定されたモジュールに関連付けます。

Qtの基本的なクラスについては、クラスのモジュールはその配置場所、すなわちディレクトリによって決定されます。しかし、ActiveQtやQt Widgets Designer のような拡張機能の場合、クラスは明示的にモジュールに関連付けられる必要があります。

このコマンドの引数はモジュール名ですが、コマンドは行の残りの部分も引数の一部として扱う点に注意してください。モジュール名の後に必ず改行を入れるようにしてください。

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

これにより、QDesignerTaskMenuExtension クラスがQt Widgets Designer モジュールに確実に含まれるようになります。つまり、例えば、 \generatelist コマンドを{classesbymodule QtDesigner} 引数で呼び出した際に生成されるリストに、そのクラスが表示されるようになります。

関連項目 \module および \generatelistも参照してください。