分组事项

分组命令将类关联到已定义的组和模块。组用于在文档中生成相关类的列表，而模块是 Qt 体系结构的一部分。

命令

\ingroup

\ingroup 命令指示给定的类、页面或其他实体属于某个相关文档组。

实体可能属于多个组。

\ingroup 命令的参数是一个组名，但请注意，该命令将行的其余部分视为其参数的一部分。确保组名后跟换行符。

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

    \ingroup io
    ...
*/

这会将 QDir 类添加到 io 组。然后，将使用例如 \annotatedlist 命令并带有参数 io 生成的列表中的条目列出 QDir。

QDoc 会自动在 C++ 类、命名空间或头文件参考页面上生成指向关联组的链接。例如，给定上述关于类 QDir 的文档和以下 \group 页面

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

QDoc 然后在 QDir 参考页面上输出一条语句

• QDir 是 输入/输出和网络 的一部分。

对于 HTML 输出，QDoc 还会作为导航栏（面包屑导航）的一部分生成指向组页面的链接。如果使用了多个 \ingroup 命令，则选择引用已记录的 \group 的第一个。

另请参阅 \group。

\inmodule

\inmodule 命令将类关联到由命令参数指定的模块。

对于 Qt 的基本类，类的模块由其位置决定，即其目录。然而，对于 ActiveQt 和 Qt Designer 这样的扩展，必须显式地将类关联到模块。

命令的参数是一个模块名，但请注意，该命令将行的其余部分视为其参数的一部分。确保模块名后跟换行符。

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

这确保了 QDesignerTaskMenuExtension 类包含在 Qt Designer 模块中，这意味着，例如，当调用带有参数 {classesbymodule QtDesigner} 的 \generatelist 命令时，该类将出现在列表中。

另请参阅 \module 和 \generatelist。