Dinge gruppieren

Die Gruppierungsbefehle ordnen Klassen definierten Gruppen und Modulen zu. Die Gruppen werden bei der Erstellung von Listen verwandter Klassen in der Dokumentation verwendet, während die Module Elemente der Qt-Struktur sind.

Befehle

\ingroup

Der Befehl „ \ingroup “ gibt an, dass die angegebene Klasse, Seite oder andere Entität zu einer bestimmten Gruppe verwandter Dokumentationselemente gehört.

Ein Element kann mehreren Gruppen angehören.

Das Argument des Befehls „ \ingroup “ ist ein Gruppenname; beachten Sie jedoch, dass der Befehl den Rest der Zeile als Teil seines Arguments betrachtet. Stellen Sie sicher, dass auf den 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 “ der Gruppe „ io “ hinzugefügt. Ein Eintrag für „ QDir “ erscheint dann in der Liste, die beispielsweise mit dem \annotatedlist Befehl mit dem Argument „ io “ erstellt wurde.

QDoc generiert automatisch Links zu zugehörigen Gruppen auf einer Referenzseite für eine C++-Klasse, einen Namespace oder einen Header. Nehmen wir beispielsweise die oben genannte Dokumentation für die Klasse QDir und die folgende \group Seite:

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

gibt QDoc dann auf der Referenzseite „ QDir “ folgende Aussage aus:

• QDir ist Teil des Moduls „Ein-/Ausgabe und Netzwerk“.

Bei der HTML-Ausgabe generiert QDoc außerdem einen Link zur Gruppenseite als Teil der Navigationsleiste (Breadcrumbs). Werden mehrere „ \ingroup “-Befehle verwendet, wird der erste ausgewählt, der auf ein dokumentiertes „ \group “ verweist.

Siehe auch \group.

\inmodule

Der Befehl „ \inmodule “ ordnet eine Klasse dem durch das Argument des Befehls angegebenen Modul zu.

Bei den Basisklassen in Qt wird das Modul einer Klasse durch ihren Speicherort, d. h. ihr Verzeichnis, bestimmt. Bei Erweiterungen wie ActiveQt und dem „ Qt Widgets Designer“ muss eine Klasse jedoch explizit einem Modul zugeordnet werden.

Das Argument des Befehls ist ein Modulname, doch beachte, dass der Befehl den Rest der Zeile als Teil seines Arguments betrachtet. Achte darauf, dass auf den Modulnamen ein Zeilenumbruch folgt.

/*!
    \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 \generatelist Befehls mit dem Argument ` {classesbymodule QtDesigner} ` erstellt wird.

Siehe auch \module und \generatelist.