物事をグループ化する
グループ化コマンドは、定義されたグループやモジュールにクラスを関連付けます。グループはドキュメントの中で関連するクラスのリストを生成するときに使われ、モジュールは 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 "を参照している最初のコマンドが選択されます。
を参照してください。
\モジュール
クラスとコマンドの引数で指定されたモジュールを関連付けます。
Qt の基本クラスでは、クラスのモジュールはその場所、つまりディレクトリによって決まります。しかし、ActiveQt や Qt Widgets Designer のような拡張機能では、クラスをモジュールに明示的に関連付ける必要があります。
コマンドの引数はモジュール名ですが、コマンドは行の残りの部分も引数の一部とみなすことに注意してください。モジュール名の後に改行があることを確認してください。
/*!
\class QDesignerTaskMenuExtension
\inmodule QtDesigner
* /
これにより、QDesignerTaskMenuExtension クラスが Qt Widgets Designer モジュールに含まれるようになります。これは、例えば、{classesbymodule QtDesigner}
引数を指定して ¦generatelistコマンドを呼び出すことで作成されるリストに、このクラスが表示されることを意味します。
本書に含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。