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

Команды структурирования документа предназначены для разделения документа на разделы. 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

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

Начало работы

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

Привет Qt

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

Установление соединений

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

Использование справочной документации

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

Создание диалоговых окон

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

Наследование от QDialog

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

...

Промежуточный Qt

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

Управление макетами

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

Основные макеты

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

...

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

\section1

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

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

\section2

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

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

\section3

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

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

\section4

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

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