Tabellen und Listen

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.

\table

Die Befehle „ \table “ und „ \endtable “ begrenzen den Inhalt einer Tabelle.

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. Ist die Breite der Tabelle kleiner als 100 %, wird die Tabelle in der generierten Dokumentation zentriert.

Eine Tabelle kann Kopfzeilen, Zeilen und Spalten enthalten. Eine Zeile beginnt mit dem \row Befehl und besteht aus Zellen, von denen jede mit einem \li Befehl. Es gibt außerdem einen \header Befehl, der eine besondere Art von Zeile mit einem speziellen Format darstellt.

/*!
   \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 Zellen auch ü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.

\header

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 \li Befehl erstellt.

Der Text einer Kopfzeilenzelle wird innerhalb der Tabellenzelle zentriert und in fetter Schrift 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 “ leitet eine neue Zeile in einer Tabelle ein. Die Elemente „\li “, 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 \li Befehl erstellt.

Die Hintergrundfarbe der Zellen jeder Zeile wechselt zwischen zwei Grautönen, wodurch sich die Zeilen leichter voneinander unterscheiden lassen. Der Inhalt der Zellen wird 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, sowie \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 „since“-Klausel in eckigen Klammern vorangestellt werden. Die Wertbeschreibung folgt auf den Wertnamen. Die Beschreibung endet an der nächsten Leerzeile oder mit „ \value “. Die Argumente werden in einer Tabelle dargestellt.

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, der Header-Datei oder der Namensraumdokumentation. Ein Beispiel finden Sie in der \enum Dokumentation für ein Beispiel.

Siehe auch \enum sowie \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ählungselements, das weggelassen werden soll. Folgt auf das Aufzählungselement eine einzeilige Beschreibung, wird diese ebenfalls weggelassen.

Ein Beispiel finden Sie in der \enum Dokumentation für ein Beispiel.

Siehe auch \enum und \value \since

\list

Die Befehle „ \list “ und „ \endlist “ begrenzen eine Liste von Elementen.

Erstellen Sie jedes Listenelement mit dem \li Befehl. Eine Liste enthält immer einen oder mehrere Einträge. 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 “ akzeptiert ein optionales Argument, das alternative Darstellungen für die Listenelemente bereitstellt.

/*!
   \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. So lernen Sie Qt
2. Installation
3. Tutorial und Beispiele

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

1. So lernst du Qt
2. Installation
3. Tutorial und Beispiele

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

1. So lernen Sie Qt
2. Installation
3. Tutorial und Beispiele

Schließlich können Sie die Listenelemente mit römischen Ziffern in aufsteigender Reihenfolge anzeigen lassen, wenn Sie „I“ als optionales Argument angeben:

1. So lernen Sie Qt
2. Installation
3. Tutorial und Beispiele

Sie können die Ausgabe auch bei einem beliebigen Zeichen oder einer beliebigen Zahl beginnen lassen, indem Sie einfach die Zahl oder das Zeichen angeben, bei dem die Ausgabe beginnen soll. 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 einen Listenpunkt. Dieser Befehl wird nur in Tabellen und Listen verwendet.

Er betrachtet alles bis zum nächsten „ \li “-Befehl, bis zum nächsten \endtableoder \endlist Befehl. Siehe \table und \list für Beispiele.

Wird der Befehl innerhalb einer Tabelle verwendet, können Sie außerdem angeben, über wie viele Zeilen oder Spalten sich das Element erstrecken 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
*/

Wird dies nicht angegeben, erstreckt sich das Element über eine Spalte und eine Zeile.

Siehe auch \table, \header, und \list.