Regrouper des choses

Les commandes de regroupement relient les classes à des groupes et des modules définis. Les groupes sont utilisés pour générer des listes de classes apparenté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 apparenté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. Assurez-vous que le nom du groupe est suivi d'un saut de ligne.

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

    \ingroup io
    ...
*/

Cette commande ajoute la classe QDir au groupe io. Une entrée pour QDir apparaîtra alors dans la liste créée avec, par exemple, la commande \annotatedlist avec l'argument io.

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

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

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

• QDir fait partie des entrées/sorties et des réseaux.

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

Voir aussi \group.

\inmodule

La commande \inmodule relie 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, à savoir son répertoire. Cependant, pour les extensions comme ActiveQt et Qt Widgets Designer, une classe doit être reliée à un module de manière explicite.

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. Assurez-vous que le nom du module est 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 créée par l'appel à la commande \generatelist avec l'argument {classesbymodule QtDesigner}.

Voir aussi \module et \generatelist.