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

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

Основные Qt

Это первая секция.

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

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

Привет Qt

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

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

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

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

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

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

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

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

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

...

Средние Qt

Это вторая секция.

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

Это первый подраздел второй секции.

Базовые макеты

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

...

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

\section1

Команда \section1 начинает новую секцию.

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

\section2

Команда \section2 начинает новую секцию.

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

\section3

Команда \section3 начинает новую секцию.

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

\section4

Команда \section4 начинает новую секцию.

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