Tabellen und Auflistungen

Mit diesen Befehlen können Sie Listen und Tabellen erstellen. Eine Liste wird linksbündig als separater Absatz dargestellt. Eine Tabelle wird zentriert als separater Absatz dargestellt. Die Breite der Tabelle hängt von der Breite ihres Inhalts ab.

\Tabelle

Die Befehle \table und \endtable grenzen den Inhalt einer Tabelle ab.

Der Befehl akzeptiert ein einzelnes Argument, das die Breite der Tabelle als Prozentsatz der Seitenbreite angibt:

/*!
   \table 100 %

      ...

   \endtable
*/

Der obige Code stellt sicher, dass die Tabelle den gesamten verfügbaren Platz ausfüllt. Wenn die Breite der Tabelle kleiner als 100 % ist, wird die Tabelle in der generierten Dokumentation zentriert.

Eine Tabelle kann Kopfzeilen, Zeilen und Spalten enthalten. Eine Zeile beginnt mit einem \row-Befehl und besteht aus Zellen, von denen jede mit einem \li-Befehl beginnt. Es gibt auch einen \header-Befehl, der eine besondere Art von Zeile ist, die ein spezielles Format hat.

/*!
   \table
   \header
       \li Qt Core Feature
       \li Brief Description
   \row
       \li \l {Signal and Slots}
       \li Signals and slots are used for communication
          between objects.
   \row
       \li \l {Layout Management}
       \li The Qt layout system provides a simple
          and powerful way of specifying the layout
          of child widgets.
   \row
       \li \l {Drag and Drop}
       \li Drag and drop provides a simple visual
          mechanism which users can use to transfer
          information between and within applications.
   \endtable
*/

Sie können auch dafür sorgen, dass sich Zellen über mehrere Zeilen und Spalten erstrecken. Zum Beispiel:

/*!
   \table
   \header
       \li {3,1} This header cell spans three columns,
          but only one row.
   \row
       \li {2, 1} This table cell spans two columns,
          but only one row
       \li {1, 2} This table cell spans only one column,
       but two rows.
   \row
       \li A regular table cell
       \li A regular table cell
   \endtable
*/

Siehe auch \header, \row und \li.

\Kopfzeile

Der Befehl \header gibt an, dass die folgenden Tabellenzellen die Spaltenüberschriften der aktuellen Tabelle sind.

Der Befehl kann nur innerhalb der Befehle \table ...\endtable verwendet werden. Eine Kopfzeile kann mehrere Zellen enthalten. Eine Zelle wird mit dem Befehl \li erstellt.

Der Text einer Kopfzelle wird innerhalb der Tabellenzelle zentriert und in einer fetten Schriftart dargestellt.

/*!
   \table
   \header
       \li Qt Core Feature
       \li Brief Description
   \row
       \li \l {Signal and Slots}
       \li Signals and slots are used for communication
          between objects.
   \endtable
*/

Siehe auch \table, \row und \li.

\row

Der Befehl \row beginnt eine neue Zeile in einer Tabelle. Die \li-Elemente, die in die neue Zeile gehören, folgen unmittelbar auf den Befehl \row.

Der Befehl kann nur innerhalb der Befehle \table ...\endtable verwendet werden. Eine Zeile kann mehrere Zellen enthalten. Eine Zelle wird mit dem Befehl \li erstellt.

Die Farbe des Zellenhintergrunds jeder Zeile wechselt zwischen zwei Grautönen, um die Unterscheidung der Zeilen voneinander zu erleichtern. Der Inhalt der Zellen ist linksbündig ausgerichtet.

/*!
   \table
   \header
       \li Qt Core Feature
       \li Brief Description
   \row
       \li \l {Signal and Slots}
       \li Signals and slots are used for communication
          between objects.
   \row
       \li \l {Layout Management}
       \li The Qt layout system provides a simple
          and powerful way of specifying the layout
          of child widgets.
   \row
       \li \l {Drag and Drop}
       \li Drag and drop provides a simple visual
          mechanism which users can use to transfer
          information between and within applications.
   \endtable
*/

Siehe auch \table, \header und \li.

\value

Der Befehl \value startet die Dokumentation eines C++-Enum-Elements.

Das erste Argument des Befehls ist der Wertname. Dem Wertnamen kann eine optionale, in eckige Klammern eingeschlossene since-Klausel vorangestellt werden. Die Beschreibung des Wertes folgt auf den Wertnamen. Die Beschreibung endet mit der nächsten Leerzeile oder dem nächsten Wert. Die Argumente werden in einer Tabelle wiedergegeben.

Ohne eine since-Klausel könnte ein \value-Befehl wie folgt aussehen:

\value QtInfoMsg A message generated by the qInfo() function.

Derselbe Befehl mit einer since-Klausel würde wie folgt aussehen:

\value [since 5.5] QtInfoMsg A message generated by the qInfo() function.

Die Dokumentation befindet sich in der zugehörigen Klasse, Header-Datei oder Namespace-Dokumentation. Ein Beispiel hierfür finden Sie in der Dokumentation zu \enum.

Siehe auch \enum und \omitvalue.

\omitvalue

Der Befehl \omitvalue schließt ein C++-Enum-Element aus der Dokumentation aus.

Das einzige obligatorische Argument des Befehls ist der Name des Aufzählungszeichens, das weggelassen wird. Wenn dem Aufzählungszeichen eine einzeilige Beschreibung folgt, wird diese ebenfalls weggelassen.

Ein Beispiel finden Sie in der Dokumentation zu \enum.

Siehe auch \enum und \value \since

\liste

Die Befehle \list und \endlist grenzen eine Liste von Elementen ab.

Erstellen Sie jedes Listenelement mit dem Befehl \li. Eine Liste enthält immer ein oder mehrere Elemente. Listen können verschachtelt werden. Zum Beispiel:

/*!
    \list
        \li Qt Reference Documentation: Getting Started
        \list
            \li How to Learn Qt
            \li Installation
            \list
                \li Qt/X11
                \li Qt/Windows
                \li Qt/Mac
                \li Qt/Embedded
            \endlist
        \li Tutorial and Examples
        \endlist
    \endlist
*/

Der Befehl \list nimmt ein optionales Argument an, das alternative Erscheinungsformen für die Listenelemente angibt.

/*!
   \list
       \li How to Learn Qt
       \li Installation
       \li Tutorial and Examples
   \endlist
*/

Wenn Sie 'A' als Argument für den Befehl \list angeben, werden die Aufzählungszeichen durch Zeichen in alphabetischer Reihenfolge ersetzt:

1. Wie man Qt lernt
2. Installation
3. Tutorial und Beispiele

Wenn Sie 'A' durch '1' ersetzen, werden die Listenelemente in aufsteigender Reihenfolge nummeriert:

1. Wie man Qt lernt
2. Installation
3. Tutorial und Beispiele

Wenn Sie 'i' als Argument angeben, werden die Aufzählungszeichen durch römische Ziffern ersetzt:

1. Wie man Qt lernt
2. Installation
3. Tutorial und Beispiele

Schließlich können Sie die Listenelemente mit römischen Zahlen in aufsteigender Reihenfolge erscheinen lassen, wenn Sie 'I' als optionales Argument angeben:

1. Wie man Qt lernt
2. Installation
3. Tutorial und Beispiele

Sie können die Auflistung auch mit einem beliebigen Zeichen oder einer Zahl beginnen lassen, indem Sie einfach die Zahl oder das Zeichen angeben, mit dem Sie beginnen möchten. Zum Beispiel:

/*!
   \list G
       \li How to Learn Qt
       \li Installation
       \li Tutorial and Examples
   \endlist
*/

Siehe auch \li.

\li (Tabellenzelle, Listenelement)

Der Befehl \li markiert eine Tabellenzelle oder ein Listenelement. Dieser Befehl wird nur in Tabellen und Listen verwendet.

Er betrachtet alles als sein Argument bis zum nächsten \li-Befehl, bis zum nächsten \endtable- oder \endlist-Befehl. Siehe \table und \list für Beispiele.

Wenn der Befehl innerhalb einer Tabelle verwendet wird, können Sie auch angeben, wie viele Zeilen oder Spalten das Element umfassen soll.

/*!
   \table
   \header
       \li {3,1} This header cell spans three columns
          but only one row.
   \row
       \li {2, 1} This table item spans two columns
          but only one row
       \li {1, 2} This table item spans only one column,
       but two rows.
   \row
       \li A regular table item
       \li A regular table item
   \endtable
*/

Wenn nichts angegeben wird, erstreckt sich das Element über eine Spalte und eine Zeile.

Siehe auch \table, \header und \list.