Last modified: 2013-04-09 02:14:17 UTC
When run on MediaWiki's codebase, doxygen outputs copious warnings about functions/classes/etc. missing documentation altogether, wrong doxygen syntax, and function arguments defined, but undocumented or documented, but not defined.
It would be nice if these could be included in Jenkins a) to guide some developers' love to this and b) to see its development over time.
There is a "Doxygen Plugin" but it just seems to provide some links to the documentation instead of parsing the doxygen log. The "Warnings Plugin" on the other hand claims to support doxygen. I think it would be useful if the output looked similar to the PMD warnings (or were integrated there).
Having it somewhere centralised, like Jenkins seems to make sense
Obviously, we have our doxygen install, but we don't display those errors anywhere publically (AFAIK)
I know some developers (including myself) have numerous ways of looking for bad documentation, ranging from running doxygen locally, to IDEs
A few weeks back I moved out legacy doxygen install on svn.wikimedia.org to doc.wikimedia.org. It now runs from a postmerge setup from Zuul/Jenkins (instead of a cronjob).
The error output is available in two places:
1) The console output in the build history:
2) Sterr and stdout are written to files as build artificats,
published on https://doc.wikimedia.org/mediawiki-core/master/php/
for the most recent gathering of Doxygen warnings.