Как мне сказать doxygen, что функция «самодокументируется»? - PullRequest
1 голос
/ 15 мая 2019

Я использую Doxygen для своего (C ++) проекта.

У меня есть некоторые функции, которые не требуют пояснений, для которых я не хочу добавлять какие-либо комментарии или пояснения, но которые я делаю хочу включить в документацию. Теперь, это происходит как стандартное поведение doxygen, если я не пишу блок /** */, но потом - я получаю предупреждение в выводе Doxygen:

warning: Member foo() of namespace bar is not documented.

Как я могу сказать doxygen, что нормально, что нет документации для таких функций?

Дополнительная информация:

  • У меня есть EXTRACT_ALL = NO
  • Я использую Doxygen 1.8.13 на Devuan ASCII (~ = Debian Stretch)

1 Ответ

0 голосов
/ 15 мая 2019

Doxygen хочет просмотреть документацию по всем функциям, которые он показывает, поэтому вам все равно придется что-то делать.

Лучше всего иметь пустую команду для этого, например:

ALIASES = selfdocumenting=" "

так что вы можете написать, например:

/// @selfdocumenting
void fie2(void);
...