Как мне сказать doxygen, что функция "самодокументируется"?
Я использую 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 ответ
Doxygen хочет видеть документацию по всем функциям, которые он показывает, поэтому вам все равно придется что-то делать.
Лучше всего было бы иметь пустую команду для этого, как:
ALIASES = selfdocumenting=" "
так что вы можете написать, например:
/// @selfdocumenting
void fie2(void);