Agrupar objetos

Los comandos de agrupación relacionan clases con grupos y módulos definidos. Los grupos se utilizan para generar listas de clases relacionadas en la documentación, mientras que los módulos son elementos de la estructura de Qt.

Comandos

\ingroup

El comando \ingroup indica que la clase, página u otra entidad dada pertenece a un determinado grupo de documentación relacionada.

Una entidad puede pertenecer a varios grupos.

El argumento del comando \ingroup es un nombre de grupo, pero tenga en cuenta que el comando considera el resto de la línea como parte de su argumento. Asegúrese de que el nombre del grupo va seguido de un salto de línea.

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

    \ingroup io
    ...
*/

Esto añade la clase QDir al grupo io. Aparecerá entonces una entrada para QDir en la lista creada con, por ejemplo, el comando \annotatedlist con el argumento io.

QDoc genera automáticamente enlaces a grupos asociados en una clase C++, espacio de nombres o página de referencia de cabecera. Por ejemplo, dada la documentación anterior para la clase QDir y la siguiente \group página:

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

A continuación, QDoc genera una declaración en la página de referencia QDir:

• QDir es parte de Input/Output y Networking.

Para la salida HTML, QDoc también genera un enlace a la página del grupo como parte de la barra de navegación (migas de pan). Si se utilizan varios comandos \ingroup, se selecciona el primero que haga referencia a un \group documentado.

Véase también \group.

\inmodule

El comando \inmodule relaciona una clase con el módulo especificado por el argumento del comando.

Para las clases básicas de Qt, el módulo de una clase viene determinado por su ubicación, es decir, su directorio. Sin embargo, para extensiones como ActiveQt y Qt Widgets Designer, una clase debe estar relacionada con un módulo explícitamente.

El argumento del comando es un nombre de módulo, pero tenga en cuenta que el comando considera el resto de la línea como parte de su argumento. Asegúrese de que el nombre del módulo va seguido de un salto de línea.

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

Esto garantiza que la clase QDesignerTaskMenuExtension se incluya en el módulo Qt Widgets Designer, lo que significa, por ejemplo, que la clase aparecerá en la lista creada al llamar al comando \generatelist con el argumento {classesbymodule QtDesigner}.

Véase también \module y \generatelist.