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

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

\table

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

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

/ *!
    \table 100 %

       ...

    \endtable
* /

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

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

/ *!
    \table
    \header
        \li Qt Core Feature
        \li Brief Description
    \row
        \li \l {Signal and Slots}
        \li Signals and slots are used for communication
           between objects.
    \row
        \li \l {Layout Management}
        \li The Qt layout system provides a simple
           and powerful way of specifying the layout
           of child widgets.
    \row
        \li \l {Drag and Drop}
        \li Drag and drop provides a simple visual
           mechanism which users can use to transfer
           information between and within applications.
    \endtable
* /

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

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

/ *!
    \table
    \header
        \li {3,1} This header cell spans three columns,
           but only one row.
    \row
        \li {2, 1} This table cell spans two columns,
           but only one row
        \li {1, 2} This table cell spans only one column,
        but two rows.
    \row
        \li A regular table cell
        \li A regular table cell
    \endtable
* /

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

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

\header

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

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

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

/ *!
    \table
    \header
        \li Qt Core Feature
        \li Brief Description
    \row
        \li \l {Signal and Slots}
        \li Signals and slots are used for communication
           between objects.
    \endtable
* /

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

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

\row

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

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

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

/ *!
    \table
    \header
        \li Qt Core Feature
        \li Brief Description
    \row
        \li \l {Signal and Slots}
        \li Signals and slots are used for communication
           between objects.
    \row
        \li \l {Layout Management}
        \li The Qt layout system provides a simple
           and powerful way of specifying the layout
           of child widgets.
    \row
        \li \l {Drag and Drop}
        \li Drag and drop provides a simple visual
           mechanism which users can use to transfer
           information between and within applications.
    \endtable
* /

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

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

\value

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

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

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

\value QtInfoMsg A message generated by the qInfo() function.

Та же команда с фразой since будет выглядеть так:

\value [since 5.5] QtInfoMsg A message generated by the qInfo() function.

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

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

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

\omitvalue

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

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

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

\list

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

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

/ *!
    \list
    \li Qt Reference Documentation: Getting Started
        \list
        \li How to Learn Qt
        \li Installation
            \list
            \li Qt/X11
            \li Qt/Windows
            \li Qt/Mac
            \li Qt/Embedded
            \endlist
        \li Tutorial and Examples
        \endlist
    \endlist
* /

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

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

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

/ *!
    \list
        \li How to Learn Qt
        \li Installation
        \li Tutorial and Examples
    \endlist
* /

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

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

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

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

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

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

Если вы укажете «i» в качестве аргумента, маркеры будут заменены римскими цифрами:

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

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

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

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

/ *!
    \list G
        \li How to Learn Qt
        \li Installation
        \li Tutorial and Examples
    \endlist
* /

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

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

См. также \li.

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

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

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

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

/ *!
    \table
    \header
        \li {3,1} This header cell spans three columns
           but only one row.
    \row
        \li {2, 1} This table item spans two columns
           but only one row
        \li {1, 2} This table item spans only one column,
        but two rows.
    \row
        \li A regular table item
        \li A regular table item
    \endtable
* /

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

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

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