物事をグループ化する

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

コマンド

\ingroup

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

一つの実体が複数のグループに属することもあります。

\ingroup コマンドの引数はグループ名ですが、コマンドは行の残りの部分も引数の一部とみなすことに注意してください。グループ名の後に改行があることを確認してください。

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

    \ingroup io
    ...
*/

これで、QDir クラスがio グループに追加されます。これにより、QDir のエントリが、例えば引数 の \annotatedlistコマンドで作成されたリストに、io のエントリが表示されます。

QDoc は、C++ クラス、ネームスペース、またはヘッダー参照ページの関連グループへのリンクを自動的に生成します。例えば、上記の QDir クラスのドキュメンテーションと、次のようになります。 \groupページがあるとします：

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

そして、QDocはQDir 参照ページに文を出力します：

• QDirはInput/OutputとNetworkingの一部です。

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.