Группирование элементов

Команды группирования связывают классы с определёнными группами и модулями. Группы используются при генерации списков взаимосвязанных классов в документации, а модули — это элементы структуры Qt.

Команды

\ingroup

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

Класс или обзор может принадлежать многим группам.

Аргументом команды \ingroup является имя группы, но обратите внимание, что команда рассматривает остальную часть строки как часть своего аргумента. Убедитесь, что имя группы следует завершать переводом строки.

/ *!
    \class QDir
    \brief The QDir class provides access to directory
           structures and their contents.

    \ingroup io
    ...
* /

Это включит класс QDir в группу io, что означает, например, что QDir будет отображаться в списке, созданном при вызове команды \group с аргументом io.

Чтобы вывести обзоры, относящиеся к определённой группе, необходимо явно сгенерировать список, используя команду \generatelist с аргументом related.

См. также \group.

\inmodule

Команда \inmodule связывает класс с модулем, указанным в аргументе команды.

Для базовых классов в Qt модуль класса определяется его расположением, а именно каталогом. Однако для расширений, таких как ActiveQt и Qt Designer, класс должен быть явно связан с модулем.

Аргументом команды является имя модуля, но обратите внимание, что команда рассматривает остальную часть строки как часть своего аргумента. Убедитесь, что имя модуля следует завершать переводом строки.

/*!
    \class QDesignerTaskMenuExtension
    \inmodule QtDesigner
* /

Это гарантирует, что класс QDesignerTaskMenuExtension будет включён в модуль Qt Designer, что означает, например, что класс будет отображаться в списке, созданном при вызове команды \generatelist с аргументом {classesbymodule QtDesigner}.

См. также \module и \generatelist.