Можно ли выбрать, какое предупреждение Doxygen показывать? - PullRequest
10 голосов
/ 13 июня 2011

Doxygen показывает предупреждение Compound ? is not documented. при строительстве. Для конкретного проекта я не хочу документировать соединения. Чтобы удалить беспорядок, я хочу видеть все другие предупреждения, кроме этого. Есть ли способ очистить выход Doxygen?

Ответы [ 3 ]

5 голосов
/ 21 июня 2011

Я не думаю, что это возможно, за исключением написания вашего собственного постпроцессора для фильтрации вывода кислорода.В вашем случае это не должно быть слишком сложно, достаточно простого grep:

doxygen <config_file> | grep -v "warning: Compound .* is not documented"

Я не совсем уверен, почему doxygen не предоставляет эту функцию: возможно, для этого потребуется слишком много опцийили более сложные варианты.Другая возможность состоит в том, что они предполагали, что, поскольку вы хотите получать предупреждения, когда что-то не документировано, не должно быть никаких исключений, за исключением случаев, когда они явно указаны в исходном коде (например, с использованием \cond и \endcond), с обоснованием, чтотакого рода упущения должны решаться только в каждом конкретном случае.Или, возможно, никто никогда не просил их включить эту функцию: не стесняйтесь заполнить запрос функции .

2 голосов
/ 16 июня 2011

Думаю, вам нужны команды if, ifnot и endif. Просто выберите подходящий ярлык и используйте правильный тег. Ex.:

/*
* \if DISPLAY_COMPOUND
* Compound doc.
* ...
* \endif
*/

doxygen оценит, знает ли он об этой метке, а если нет, он проигнорирует любой комментарий вплоть до команды \endif в том же блоке комментариев

Затем вам нужно определить (или нет) эту метку в вашем докси-файле в ENABLED_SECTIONS.

#comment the next line if you don't want to document Compound
ENABLED_SECTIONS = DISPLAY_COMPOUND

Посмотрите также на команды \cond и \endcond, которые похожи, но не совсем одинаковые (они включают или отключают целые разделы файла, а не только один блок комментариев).

0 голосов
/ 20 ноября 2013

Вы можете отключить предупреждения в конфигурации Doxygen. Смотрите здесь: Документирование кислорода

Мой любимый: WARN_IF_UNDOCUMENTED = NO

...