Таблицы и списки

Эти команды позволяют создавать списки и таблицы. Список отображается выровненным по левому краю как отдельный абзац. Таблица отображается по центру как отдельный абзац. Ширина таблицы зависит от ширины ее содержимого.

\table

Команды \table и \endtable ограничивают содержимое таблицы.

Команда принимает один аргумент, определяющий ширину таблицы в процентах от ширины страницы:

Эта строка кода обеспечивает, чтобы таблица заполняла все доступное пространство. Если ширина таблицы меньше 100 %, таблица будет центрирована в генерируемой документации.

Таблица может содержать заголовки, строки и столбцы. Строка начинается с команды \row и состоит из ячеек, каждая из которых начинается с команды \li. Также есть команда \header, которая является специальным видом строки со специальным форматом.

QDoc отображает это так:

Вы также можете сделать ячейки занимающими несколько строк и столбцов. Например:

QDoc отображает это так:

См. также \header, \row и \li.

\header

Команда \header указывает, что следующие ячейки таблицы являются заголовками столбцов текущей таблицы.

Команда может использоваться только внутри команд \table...\endtable. Заголовок может содержать несколько ячеек. Ячейка создается с помощью команды \li.

Текст ячейки заголовка центрируется в ячейке таблицы и отображается жирным шрифтом.

QDoc отображает это так:

См. также \table, \row и \li.

\row

Команда \row начинает новую строку в таблице. Элементы \li, которые должны принадлежать новой строке, следуют непосредственно за \row.

Команда может использоваться только внутри команд \table...\endtable. Строка может содержать несколько ячеек. Ячейка создается с помощью команды \li.

Цвет фона каждой строки чередуется между двумя оттенками серого, что облегчает различение строк. Содержимое ячеек выравнивается по левому краю.

QDoc отображает это так:

См. также \table, \header и \li.

\value

Команда \value начинает документирование элемента перечисления C++.

Первый аргумент команды — имя значения. Имя значения может предваряться необязательной частью since в квадратных скобках. Описание значения следует за именем значения. Описание заканчивается на следующей пустой строке или команде \value. Аргументы отображаются в таблице.

Без части since команда \value может выглядеть так:

Та же команда с частью since выглядит так:

Документация будет расположена в связанном классе, заголовочном файле или в пространстве имен. См. документацию \enum для примера.

Примечание: начиная с Qt 5.4, команда \value также может использоваться вне темы \enum. В этом случае QDoc отображает таблицу из двух столбцов, перечисляющую имя константы (взятое как есть из первого аргумента) и её описание. Это можно использовать, например, в теме \qmlproperty для документирования допустимых значений для свойства перечисления QML.

См. также \enum и \omitvalue.

\omitvalue

Команда \omitvalue исключает элемент перечисления C++ из документации.

Единственный аргумент команды — имя элемента перечисления, который будет исключен. См. документацию \enum для примера.

См. также \enum, \value и \since.

\list

Команды \list и \endlist ограничивают список элементов.

Создайте каждый элемент списка с помощью команды \li. Список всегда содержит один или более элементов. Списки могут быть вложенными. Например:

QDoc отображает это так:

• Qt Справочная документация: Начало работы
  • Как изучить Qt
  • Установка
    • Qt/X11
    • Qt/Windows
    • Qt/Mac
    • Qt/Embedded
  • Учебник и примеры

Команда \list принимает необязательный аргумент, предоставляющий альтернативные представления для элементов списка.

QDoc отображает элементы списка с маркерами (по умолчанию):

• Как изучить Qt
• Установка
• Учебник и примеры

Если вы укажете 'A' как аргумент команды \list, маркеры заменяются символами в алфавитном порядке:

1. Как изучить Qt
2. Установка
3. Учебник и примеры

Если вы замените 'A' на '1', элементы списка нумеруются в порядке возрастания:

1. Как изучить Qt
2. Установка
3. Учебник и примеры

Если вы укажете 'i' в качестве аргумента, маркеры заменяются римскими цифрами:

1. Как изучить Qt
2. Установка
3. Учебник и примеры

Наконец, вы можете сделать элементы списка отображаемыми с римскими цифрами в порядке возрастания, если вы укажете 'I' в качестве необязательного аргумента:

1. Как изучить Qt
2. Установка
3. Учебник и примеры

Вы также можете начать нумерацию с любого символа или числа, просто указав нужное число или символ. Например:

QDoc отображает это так:

7. Как изучить Qt
8. Установка
9. Учебник и примеры

См. также \li.

\li (ячейка таблицы, элемент списка)

Команда \li отмечает ячейку таблицы или элемент списка. Эта команда используется только в таблицах и списках.

Она рассматривает все как аргумент до следующей команды \li, до следующей команды \endtable или \endlist. См. \table и \list для примеров.

Если команда используется в таблице, вы также можете указать, сколько строк или столбцов должно занимать этот элемент.

QDoc отображает это так:

Если не указано иное, элемент будет занимать один столбец и одну строку.

См. также \table, \header и \list.