Индекс кислородных групп и модулей

Question

Я создаю документ Doxygen для моего проекта. Недавно я сгруппировал связанные классы, используя \addtogroup тег. После этого у меня есть вкладка модуля в моей документации. Показывает все модули. Я хочу добавить описание прямо под именем модуля под именем модуля на той же странице. Как я могу сделать это с помощью Doxygen?

Вот мой тег

/*! \addtogroup test test
 *  Test Testing a group in doxygen
 *  @{
 */

Answer 1

Вы должны написать специальный.h файл, который содержит только комментарии. Для каждой группы вы определяете комментарий следующим образом:

/** @defgroup FooGroup
 *
 * This module does yada yada yada
 *
 */

Затем вы назначаете определение группе (даже для разных файлов) следующим образом:

/** @addtogroup FooGroup */
/*@{*/

/** Summon a goat
 *
 * @param name The name of the goat;
 * @return The summoned goat;
 */
Goat summon_goat (const char *name);

...
...

/*@}*/

РЕДАКТИРОВАТЬ:

И это так. Смотрите "Подробное описание"? Вы также можете добавить фрагмент кода и примеры в @verbatim а также @endverbatim команды.