Dokumentstruktur

Die Befehle zur Dokumentstrukturierung dienen dazu, Ihr Dokument in Abschnitte zu unterteilen. QDoc unterstützt vier Abschnittsstufen: \section1, \section2, \section3 und \section4. Die Abschnittsbefehle entsprechen den traditionellen Begriffen „Abschnitt“, „Unterabschnitt“ usw., die bei der Gliederung verwendet werden.

Abschnittsbefehle

Im Allgemeinen betrachtet ein Befehl zur Dokumentstrukturierung alles, was ihm folgt, bis zum ersten Zeilenumbruch, als sein Argument. Das Argument wird als Titel der Einheit dargestellt. Wenn der Titel über mehrere Zeilen verteilt werden soll, stellen Sie sicher, dass jede Zeile (außer der letzten) mit einem Backslash endet.

Insgesamt gibt es in QDoc vier Ebenen für Abschnitte: \section1, \section2, \section3 und \section4. Diese entsprechen den herkömmlichen Bezeichnungen „Abschnitt“, „Unterabschnitt“, „Unter-Unterabschnitt“ und „Unter-Unter-Unterabschnitt“.

Es gibt eine strenge Reihenfolge der Abschnitteinheiten:

section1
      |
      section2
             |
             section3
                    |
                    section4

Wenn Abschnitte verwendet werden, sollte 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 im Dokument. Die Abschnittsüberschrift erscheint im automatisch generierten Inhaltsverzeichnis, das normalerweise in der oberen rechten Ecke der Seite angezeigt wird.

\section1

Mit dem Befehl „ \section1 “ wird ein neuer Abschnitt begonnen.

Eine Erläuterung der verschiedenen Abschnittseinheiten, Befehlsargumente und Darstellungsmöglichkeiten finden Sie unter „Abschnittsbefehle “.

\section2

Der Befehl „ \section2 “ leitet einen neuen Abschnitt ein.

Eine Erläuterung der verschiedenen Abschnitteinheiten, Befehlsargumente und der Darstellung finden Sie unter „Abschnittsbefehle “.

\section3

Der Befehl „ \section3 “ leitet einen neuen Abschnitt ein.

Eine Erläuterung der verschiedenen Abschnitteinheiten, Befehlsargumente und der Darstellung finden Sie unter „Abschnittsbefehle “.

\section4

Der Befehl „ \section4 “ leitet einen neuen Abschnitt ein.

Eine Erläuterung der verschiedenen Abschnitteinheiten, Befehlsargumente und der Darstellung finden Sie unter „Abschnittbefehle “.