Regrouper des objets

Les commandes de regroupement associent des classes à des groupes et à des modules définis. Les groupes sont utilisés lors de la génération de listes de classes associées dans la documentation, tandis que les modules sont des éléments de la structure de Qt.

Commandes

\ingroup

La commande « \ingroup » indique que la classe, la page ou toute autre entité donnée appartient à un certain groupe de documentation associée.

Une entité peut appartenir à plusieurs groupes.

L'argument de la commande « \ingroup » est un nom de groupe, mais notez que la commande considère le reste de la ligne comme faisant partie de son argument. Veillez à ce que le nom du groupe soit suivi d'un saut de ligne.

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

    \ingroup io
    ...
*/

Cela ajoute la classe « QDir » au groupe « io ». Une entrée « QDir » apparaîtra alors dans la liste créée, par exemple, à l’aide de la \annotatedlist commande avec l’argument io.

QDoc génère automatiquement des liens vers les groupes associés sur une page de référence de classe, d'espace de noms ou d'en-tête C++. Par exemple, compte tenu de la documentation ci-dessus concernant la classe QDir et de la \group page :

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

QDoc génère alors une instruction sur la page de référence QDir:

• QDir fait partie des modules d'entrée/sortie et de réseau.

Pour la sortie HTML, QDoc génère également un lien vers la page du groupe dans la barre de navigation (fil d'Ariane). Si plusieurs commandes « \ingroup » sont utilisées, la première qui fait référence à une \group documentée est sélectionnée.

Voir aussi \group.

\inmodule

La commande « \inmodule » associe une classe au module spécifié par l'argument de la commande.

Pour les classes de base de Qt, le module d’une classe est déterminé par son emplacement, c’est-à-dire son répertoire. Cependant, pour les extensions telles qu’ActiveQt et Qt Widgets Designer, une classe doit être explicitement associée à un module.

L'argument de la commande est un nom de module, mais notez que la commande considère le reste de la ligne comme faisant partie de son argument. Veillez à ce que le nom du module soit suivi d'un saut de ligne.

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

Cela garantit que la classe QDesignerTaskMenuExtension est incluse dans le module Qt Widgets Designer, ce qui signifie, par exemple, que la classe apparaîtra dans la liste générée par l'appel de la \generatelist commande avec l’argument « {classesbymodule QtDesigner} ».

Voir également \module et \generatelist.