Индекс кислородных групп и модулей - PullRequest
Новая
       30

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

2 голосов
/ 30 марта 2010

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

Вот мой тег 

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

1 Ответ

16 голосов
/ 04 августа 2010

Вы должны написать специальный файл .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);

...
...

/*@}*/

EDIT

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

...