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

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

\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 Reference Documentation: Getting Started
  • Как изучать 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.