Suppressing Doxygen warnings
Is there a way to suppress Doxygen from giving "not documented" warnings on particular files? My project has several automatically generated code headers that cause it to throw hundreds or thousands of errors that make it difficult to sift through.
2 ответа
Вы можете использовать теги подавления в сгенерированных файлах:
//! @cond Doxygen_Suppress
code
//! @endcond
Вам не нужен "Doxygen_Suppress", но мне он нравится для ясности.
Дополнительные параметры можно найти в FAQ по doxygen
РЕДАКТИРОВАТЬ: Хорошо, мне следовало проявить должную осмотрительность, у меня есть ответ, который больше подходит для вашей ситуации. Я считаю, что вам нужно полностью исключить файлы. Добавьте это в свой файл 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) и выберите все, что вам нужно, и пусть он сохранит файл. doxyfile для вас.
Для этого есть опция конфигурации, как указано в документации
WARN_IF_UNDOCUMENTEDЕсли для
WARN_IF_UNDOCUMENTEDзадано значениеYES, тогда doxygen будет генерировать предупреждения для недокументированных участников. ЕслиEXTRACT_ALLустановлен наYES, тогда этот флаг будет автоматически инвалид.