物事をグループ化する

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

コマンド

\グループ化

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

エンティティは、複数のグループに属することができます。

グループ名の後に必ず改行を入れてください。グループ名の後に改行があることを確認してください。

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

    \ingroup io
    ...
*/

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

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

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

QDoc は、QDir 参照ページにステートメントを出力します：

• QDirはInput/OutputおよびNetworkingの一部です。

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

を参照してください。

\モジュール

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

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

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

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

これにより、QDesignerTaskMenuExtension クラスがQt Widgets Designer モジュールに含まれるようになります。これは、例えば、{classesbymodule QtDesigner} 引数を指定して\generatelistコマンドを呼び出して作成されたリストに、このクラスが表示されることを意味します。

このことは、例えば、引数。