Doxygen показывает предупреждение Compound ? is not documented.
при сборке. Для конкретного проекта я не хочу документировать соединения. Чтобы убрать беспорядок, я хочу видеть все остальные предупреждения, кроме этого. Есть ли способ очистить вывод Doxygen?
Можно ли выбрать, какое предупреждение Doxygen показывать?
Ответы (3)
Я не думаю, что это возможно, кроме как написать собственный постпроцессор для фильтрации вывода doxygen. В вашем случае это не должно быть слишком сложно, достаточно простого grep
:
doxygen <config_file> | grep -v "warning: Compound .* is not documented"
Я не совсем уверен, почему doxygen не предоставляет эту функцию: возможно, для этого потребуется слишком много опций или более сложные опции. Другая возможность заключается в том, что они предположили, что, поскольку вы хотите получать предупреждения, когда что-то не задокументировано, не должно быть никаких исключений, за исключением случаев, когда это явно указано в исходном коде (например, с использованием \cond
и \endcond
), с обоснованием того, что такого рода упущения следует решать только в каждом конкретном случае. Или, возможно, никто никогда не просил их включить эту функцию: не стесняйтесь заполнять запрос функции.
Я думаю, что вы ищете команды if
, ifnot
и endif
. Просто выберите подходящий ярлык, а затем используйте правильный тег. Бывший.:
/*
* \if DISPLAY_COMPOUND
* Compound doc.
* ...
* \endif
*/
doxygen оценит, знает ли он об этой метке, и если нет, он проигнорирует любой комментарий до команды \endif
в том же блоке комментариев.
Затем вам нужно определить (или нет) эту метку в вашем doxyfile в ENABLED_SECTIONS.
#comment the next line if you don't want to document Compound
ENABLED_SECTIONS = DISPLAY_COMPOUND
Взгляните также на команды \cond
и \endcond
, которые похожи, но не совсем одинаковы (они включают или отключают целые разделы файла, а не только один блок комментариев).
ENABLED_SECTIONS =
(пусто). Ваш ответ не распространяется на мою проблему. Я не хочу включать или отключать создание составных документов. Я хочу отключить предупреждения только для соединений.
- person Jader Dias; 17.06.2011
Вы можете отключить предупреждения в конфигурации doxygen. См. здесь: документацию по doxygen
Мой любимый вариант: WARN_IF_UNDOCUMENTED = NO