Подавление предупреждений Doxygen - PullRequest
14 голосов
/ 17 августа 2010

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

Ответы [ 4 ]

13 голосов
/ 18 августа 2010

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

WARN_IF_UNDOCUMENTED

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

11 голосов
/ 18 августа 2010

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

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

Там вам не нужен "Doxygen_Suppress", но для ясности он мне нравится.

Есть и другие варианты в doxygen FAQ

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 , но если вы ленивы, как я, просто воспользуйтесь инструментом графического интерфейса (doxywizard), пройдите и выберите все, что вы хотите, и сохраните доксифайл для вас.

1 голос
/ 04 мая 2011

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

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

0 голосов
/ 05 августа 2014

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

Итак:

  • щелкните правой кнопкой мыши свой докси-файл и выберите «open-with» -> «текстовый редактор»
  • поиск WARN_IF_UNDOCUMENTED (по умолчанию установлено «YES»)
  • изменить на « NO ».

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

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

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

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

...