Подавление предупреждений Doxygen

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

ОТВЕТЫ

Ответ 1

Вы можете использовать теги подавления в сгенерированных файлах:

//! @cond Doxygen_Suppress
code
//! @endcond

Вам не нужен "Doxygen_Suppress", но мне это нужно для ясности.

В дополнительных настройках doxygen больше

EDIT: Хорошо, я должен был выполнить свою должную осмотрительность, у меня есть ответ, более подходящий для вашей ситуации. Я считаю, что вам нужно полностью исключить файлы. Добавьте это в свой файл doxygen:

# The EXCLUDE tag can be used to specify files and/or directories that should 
# excluded from the INPUT source files. This way you can easily exclude a 
# subdirectory from a directory tree whose root is specified with the INPUT tag.

EXCLUDE                = abc.cpp \
                         abc.h

Ирония заключается в том, что у меня была эта проблема и она ее разрешила, а потом забыла обо всем этом... Мозг снова должен быть полным.

Я вытащил эту информацию из страницы конфигурации doxygen, но если вы ленитесь, как я, просто используйте инструмент gui (doxywizard) и идите и выберите все нужные вещи и сохраните файл doxyfile для вас.

Ответ 2

Здесь есть опция конфигурации, как указано в документации

WARN_IF_UNDOCUMENTED

Если WARN_IF_UNDOCUMENTED установлено на YES, тогда doxygen будет генерировать предупреждения для недокументированных участников. Если EXTRACT_ALL установлен на YES, тогда этот флаг будет автоматически отключено.

Ответ 3

В моих автоматически созданных заголовках я просто добавляю документацию doxygen в процедуру автоматического генерации.

Это означает, что ничего не осталось недокументированным.

Ответ 4

Если кто-то использует Eclipse, я определенно предлагаю открыть ваш файл (*.doxyfile) с помощью текстового редактора (обратите внимание, что eclipse открывает его с помощью "Doxyfile Editor" по умолчанию).

Итак:

  • щелкните правой кнопкой мыши на вашем doxyfile и выберите "open-with" → "text editor"
  • найдите WARN_IF_UNDOCUMENTED (по умолчанию установлено "ДА" )
  • изменить NO.

Добавление тегов

//! @cond Doxygen_Suppress
code
//! @endcond

если у вас много классов, должно быть скучно и сложно.

Документация для других параметров конфигурации доступна здесь.