Agrupar objetos
Los comandos de agrupación relacionan las clases con grupos y módulos definidos. Los grupos se utilizan al 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 especificada 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 ten en cuenta que el comando considera el resto de la línea como parte de su argumento. Asegúrate de que el nombre del grupo vaya 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 ». A continuación, aparecerá una entrada para « QDir » en la lista creada, por ejemplo, con el \annotatedlist comando con el argumento io.
QDoc genera automáticamente enlaces a los grupos asociados en una página de referencia de una clase, un espacio de nombres o un encabezado de C++. Por ejemplo, dada la documentación anterior de la clase QDir y la siguiente \group página:
/*
\group io
\title Input/Output and Networking
...
*/QDoc genera entonces una entrada en la página de referencia de QDir:
- QDir forma parte de «Entrada/Salida y Redes».
Para la salida en HTML, QDoc también genera un enlace a la página del grupo como parte de la barra de navegación (ruta de navegación). 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 » vincula una clase al módulo especificado por el argumento del comando.
En el caso de las clases básicas de Qt, el módulo de una clase viene determinado por su ubicación, es decir, su directorio. Sin embargo, en el caso de extensiones como ActiveQt y Qt Widgets Designer, una clase debe vincularse a un módulo de forma explícita.
El argumento del comando es un nombre de módulo, pero ten en cuenta que el comando considera el resto de la línea como parte de su argumento. Asegúrate de que el nombre del módulo vaya 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 \generatelist comando con el argumento {classesbymodule QtDesigner}.
Véase también \module y \generatelist.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.