Dinge gruppieren

Die Gruppierungsbefehle beziehen Klassen auf definierte Gruppen und Module. Die Gruppen werden bei der Erstellung von Listen verwandter Klassen in der Dokumentation verwendet, während die Module Elemente der Struktur von Qt sind.

Befehle

\gruppieren

Der Befehl \ingroup zeigt an, dass die angegebene Klasse, Seite oder andere Entität zu einer bestimmten Gruppe von verwandten Dokumentationen gehört.

Eine Entität kann zu mehreren Gruppen gehören.

Das Argument des Befehls \ingroup ist ein Gruppenname, aber beachten Sie, dass der Befehl den Rest der Zeile als Teil seines Arguments betrachtet. Achten Sie darauf, dass dem Gruppennamen ein Zeilenumbruch folgt.

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

    \ingroup io
    ...
*/

Dadurch wird die Klasse QDir zur Gruppe io hinzugefügt. Ein Eintrag für QDir erscheint dann in der Liste, die z. B. mit dem Befehl \annotatedlist mit dem Argument io erstellt wurde.

QDoc generiert automatisch Links zu assoziierten Gruppen auf einer C++ Klassen-, Namespace- oder Header-Referenzseite. Nehmen wir zum Beispiel die obige Dokumentation für die Klasse QDir und die folgende \group-Seite:

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

QDoc gibt dann eine Anweisung auf der Referenzseite QDir aus:

• QDir ist Teil von Input/Output und Networking.

Bei der HTML-Ausgabe erzeugt QDoc auch einen Link zur Gruppenseite als Teil der Navigationsleiste (Breadcrumbs). Wenn mehrere \ingroup-Befehle verwendet werden, wird der erste Befehl ausgewählt, der auf eine dokumentierte \group verweist.

Siehe auch \group.

\inmodule

Der Befehl \inmodule verknüpft eine Klasse mit dem Modul, das durch das Argument des Befehls angegeben wird.

Für die Basisklassen in Qt wird das Modul einer Klasse durch ihren Speicherort, d.h. ihr Verzeichnis, bestimmt. Für Erweiterungen wie ActiveQt und Qt Widgets Designer muss eine Klasse jedoch explizit mit einem Modul verknüpft werden.

Das Argument des Befehls ist ein Modulname, aber beachten Sie, dass der Befehl den Rest der Zeile als Teil seines Arguments betrachtet. Stellen Sie sicher, dass der Modulname von einem Zeilenumbruch gefolgt wird.

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

Dadurch wird sichergestellt, dass die Klasse QDesignerTaskMenuExtension in das Modul Qt Widgets Designer aufgenommen wird, was beispielsweise bedeutet, dass die Klasse in der Liste erscheint, die durch den Aufruf des Befehls \generatelist mit dem Argument {classesbymodule QtDesigner} erstellt wird.

Siehe auch \module und \generatelist.