Structure du document

Les commandes de structuration du document permettent de diviser votre document en sections. QDoc prend en charge quatre niveaux de section : \section1 \section2 , \section3, et \section4. Les commandes de section correspondent aux traditionnelles sections, sous-sections, etc. utilisées dans la rédaction de plans.

Commandes de section

En général, une commande de structuration de document considère comme argument tout ce qui la suit jusqu'au premier saut de ligne. L'argument est rendu comme le titre de l'unité. Si le titre doit s'étendre sur plusieurs lignes, assurez-vous que chaque ligne (à l'exception de la dernière) se termine par une barre oblique inverse.

Au total, il existe quatre niveaux de sections dans QDoc : \section1, \section2, \section3 et \section4. Ces niveaux correspondent aux traditionnelles section, sous-section, sous-sous-section et sous-sous-section.

Il existe un ordre strict des unités de section :

section1
      |
      section2
             |
             section3
                    |
                    section4

Lorsque des sections sont utilisées, la première commande de section doit être section1.

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

        ...
*/

Chaque section est une unité logique dans le document. Le titre de la section apparaît dans la table des matières générée automatiquement, qui apparaît normalement dans le coin supérieur droit de la page.

\section1

La commande \section1 démarre une nouvelle section.

Voir les commandes de section pour une explication des différentes unités de section, des arguments de commande et du rendu.

\section2

La commande \section2 démarre une nouvelle section.

Voir les commandes de section pour une explication des différentes unités de section, de l'argument de la commande et du rendu.

\section3

La commande \section3 démarre une nouvelle section.

Voir les commandes de section pour une explication des différentes unités de section, de l'argument de la commande et du rendu.

\section4

La commande \section4 démarre une nouvelle section.

Voir les commandes de section pour une explication des différentes unités de section, de l'argument de la commande et du rendu.