Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is it possible to choose which Doxygen warning to show?

Doxygen shows a Compound ? is not documented. warning when building. For a specific project I don't want to document Compounds. To remove clutter I want to see all other warnings except that one. Is there a way to clean the Doxygen output?

like image 630
Jader Dias Avatar asked Jun 13 '11 17:06

Jader Dias


1 Answers

I don't think this is possible, except by writing your own post-processor to filter doxygen output. In your case, this should not be too hard, a simple grep should be sufficient:

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

I'm not really sure why doxygen does not provide this feature: perhaps it would require too much options, or more complicated options. Another possibility is that they assumed that since you want to be warned when something is not documented, there should be no exceptions except when explicitly specified in the source code (using \cond and \endcond, for example), with the rationale that this kind of omission should only be decided on a case-by-case basis. Or perhaps nobody ever asked them to include this feature: feel free to fill in a feature request.

like image 185
Luc Touraille Avatar answered Dec 25 '22 08:12

Luc Touraille