Почему документация Doxygen появляется только для последней из нескольких смежных групп? - PullRequest
3 голосов
/ 26 февраля 2011

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

// @{
//! @brief Some documentation
int func1(void);
int func2(void);
// @}

// @{
//! @brief Some other documentation
int func3(void);
int func4(void);
// @}

Однако, когда я запускаю doxygen, отображает только 2-ю группу сообщение @brief в выводе HTML.Я делаю что-то не так, или это потенциальная ошибка?

Обратите внимание, я не пытаюсь вложить группы, что в документации по документу doxygen запрещено.

Ответы [ 3 ]

4 голосов
/ 26 февраля 2013

Чтобы это работало, вам необходимо включить DISTRIBUTE_GROUP_DOC в вашей конфигурации.И код, указанный как:

//@{
//! Same documentation for both members. Details ...
void func1InGroup1();
void func2InGroup1();
//@}

И если вы хотите назвать сгруппированный раздел:

//! @name Group name
//@{
//! Same documentation for both members. Details ...
void func1InGroup1();
void func2InGroup1();
//@}
2 голосов
/ 28 февраля 2011

Решено!

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

//! @brief Some documentation
// @{
int func1(void);
int func2(void);
// @}

//! @brief Some other documentation
// @{
int func3(void);
int func4(void);
// @}
0 голосов
/ 26 февраля 2011

Просто мысль: Doxygen придирчив, когда дело доходит до пробела. Убедитесь, что вы используете '// @ {', а не '// @ {'.

...