Структура документа

Команды структурирования документа предназначены для разделения документа на разделы. QDoc поддерживает четыре уровня разделов: \section1, \section2, \section3 и \section4. Команды разделов соответствуют традиционным разделам, подразделам и т. д., используемым в схемах.

Команды разделов

В общем случае команда структурирования документа рассматривает всё, что следует за ней, до первой строки разрыва, как свой аргумент. Аргумент отображается как заголовок блока. Если заголовок нужно отобразить на нескольких строках, убедитесь, что каждая строка (кроме последней) заканчивается обратным слэшем.

Всего в QDoc существует четыре уровня разделов: \section1, \section2, \section3 и \section4. Они соответствуют традиционным разделам, подразделам, подподразделам и подподподразделам.

Существует строгий порядок расположения блоков разделов:

section1
       |
       section2
              |
              section3
                     |
                     section4

При использовании разделов первой должна быть команда 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.

    ...
* /

QDoc отображает это следующим образом:

Basic Qt

Это первый раздел.

Getting Started

Это первый подраздел.

Hello Qt

Это первый подподраздел.

Making Connections

Это второй подподраздел.

Using the Reference Documentation

Это третий подподраздел.

Creating Dialogs

Это второй подраздел.

Subclassing QDialog

Это первый подподраздел.

...

Intermediate Qt

Это второй раздел.

Layout Management

Это первый подраздел второго раздела.

Basic Layouts

Это первый подподраздел.

...

Каждый раздел является логическим блоком в документе. Заголовок раздела отображается в автоматически генерируемом оглавлении, которое обычно отображается в правом верхнем углу страницы.

\section1

Команда \section1 начинает новый раздел.

См. Команды разделов для объяснения различных блоков разделов, аргументов команд и отображения.

\section2

Команда \section2 начинает новый подраздел.

См. Команды разделов для объяснения различных блоков разделов, аргументов команд и отображения.

\section3

Команда \section3 начинает новый подподраздел.

См. Команды разделов для объяснения различных блоков разделов, аргументов команд и отображения.

\section4

Команда \section4 начинает новый подподподраздел.

См. Команды разделов для объяснения различных блоков разделов, аргументов команд и отображения.