Estructura del documento

Los comandos de estructuración del documento sirven para dividirlo en secciones. QDoc soporta cuatro niveles de sección: \section1, \section2, \section3, y \section4. Los comandos de sección se corresponden con los tradicionales sección, subsección, etc. utilizados en los esquemas.

Comandos de sección

En general, un comando de estructuración de documentos considera como argumento todo lo que le sigue hasta el primer salto de línea. El argumento se convierte en el título de la unidad. Si el título debe abarcar varias líneas, asegúrese de que cada línea (excepto la última) termina con una barra invertida.

En total, existen cuatro niveles para las secciones en QDoc: \section1, \section2, \section3 y \section4. Corresponden a la sección, subsección, subsubsección y subsubsubsección tradicionales.

Existe un orden estricto de las unidades de sección:

section1
      |
      section2
             |
             section3
                    |
                    section4

Cuando se utilizan secciones, la primera orden de sección debe ser 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.

        ...
*/

Cada sección es una unidad lógica del documento. El encabezamiento de la sección aparece en el índice generado automáticamente que suele aparecer en la esquina superior derecha de la página.

\section1

El comando \section1 inicia una nueva sección.

Consulte Comandos de sección para obtener una explicación de las distintas unidades de sección, el argumento del comando y la representación.

\section2

El comando \section2 inicia una nueva sección.

Consulte Comandos de sección para obtener una explicación de las distintas unidades de sección, el argumento del comando y la representación.

\section3

El comando \section3 inicia una nueva sección.

Consulte Comandos de sección para obtener una explicación de las distintas unidades de sección, el argumento del comando y la representación.

\section4

El comando \section4 inicia una nueva sección.

Consulte Comandos de sección para obtener una explicación de las distintas unidades de sección, el argumento del comando y la representación.