Dokumentstruktur

Die Befehle zur Dokumentstrukturierung dienen dazu, Ihr Dokument in Abschnitte zu unterteilen. QDoc unterstützt vier Ebenen von Abschnitten: \section1, \section2, \section3, und \section4. Die Abschnittsbefehle entsprechen den traditionellen Abschnitten, Unterabschnitten usw., die in Gliederungen verwendet werden.

Abschnittsbefehle

Im Allgemeinen betrachtet ein Befehl zur Strukturierung eines Dokuments alles, was ihm bis zum ersten Zeilenumbruch folgt, als sein Argument. Das Argument wird als Titel der Einheit wiedergegeben. Wenn sich der Titel über mehrere Zeilen erstrecken muss, stellen Sie sicher, dass jede Zeile (außer der letzten) mit einem Backslash abgeschlossen wird.

Insgesamt gibt es vier Ebenen für Abschnitte in QDoc: \section1, \section2, \section3 und \section4. Diese entsprechen den traditionellen Abschnitten, Unterabschnitten, Unterunterabschnitten und Unterunterabschnitten.

Es gibt eine strikte Reihenfolge der Abschnittseinheiten:

section1
      |
      section2
             |
             section3
                    |
                    section4

Wenn Abschnitte verwendet werden, muss der erste Abschnittsbefehl section1 lauten.

/*!
    \section1 Basic Qt

    This is the first section.


        \section2 Getting Started

        This is the first subsection.


            \section3 Hello Qt

            This is the first subsubsection.


            \section3 Making Connections

            This is the second subsubsection.


            \section3 Using the Reference Documentation

            This is the third subsubsection.


        \section2 Creating Dialogs

        This is the second subsection.


            \section3 Subclassing QDialog

            This is the first subsubsection.

            ...


    \section1 Intermediate Qt

    This is the second section.


        \section2 Layout Management

        This is the second section's first subsection.


            \section3 Basic Layouts

            This is the first subsubsection.

        ...
*/

Jeder Abschnitt ist eine logische Einheit des Dokuments. Die Abschnittsüberschrift erscheint im automatisch generierten Inhaltsverzeichnis, das normalerweise in der oberen rechten Ecke der Seite erscheint.

\Abschnitt1

Mit dem Befehl \section1 wird ein neuer Abschnitt begonnen.

Eine Erläuterung der verschiedenen Abschnittseinheiten, des Befehlsarguments und der Darstellung finden Sie unter Abschnittsbefehle.

\section2

Mit dem Befehl \section2 wird ein neuer Abschnitt begonnen.

Eine Erläuterung der verschiedenen Abschnittseinheiten, des Befehlsarguments und der Darstellung finden Sie unter Abschnittsbefehle.

\section3

Mit dem Befehl \section3 wird ein neuer Abschnitt begonnen.

Eine Erläuterung der verschiedenen Abschnittseinheiten, des Befehlsarguments und der Darstellung finden Sie unter Abschnittsbefehle.

\section4

Mit dem Befehl \section4 wird ein neuer Abschnitt begonnen.

Eine Erläuterung der verschiedenen Abschnittseinheiten, des Befehlsarguments und der Darstellung finden Sie unter Abschnittsbefehle.