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

Команды группировки связывают классы с определенными группами и модулями. Группы используются при генерации списков связанных классов в документации, а модули — это элементы структуры 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.