Как мне сообщить doxygen, что функция самодокументируется?

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

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

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

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

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

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

code-documentation doxygen self-documenting-code
person einpoklum    schedule 15.05.2019    source источник
comment
В вашем файле конфигурации doxygen какое значение установлено для параметра EXTRACT_ALL?   -  person P.W    schedule 15.05.2019
comment
Пожалуйста, всегда указывайте используемую версию doxygen. @P.W Может иметь некоторые побочные эффекты, такие как дополнительные нежелательные функции.   -  person albert    schedule 15.05.2019
comment
@P.W: см. редактирование.   -  person einpoklum    schedule 15.05.2019
comment
@albert: см. редактирование.   -  person einpoklum    schedule 15.05.2019

Ответы (1)


arrow_upward
0
arrow_downward

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

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

ALIASES = selfdocumenting=" "

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

/// @selfdocumenting
void fie2(void);
person albert    schedule 15.05.2019
comment
Но не создаст ли это пробелов в документации? - person einpoklum; 15.05.2019
comment
Это действительно приведет к некоторым дополнительным пробельным блокам. - person albert; 15.05.2019