Last modified: 2013-04-09 02:14:17 UTC

Wikimedia Bugzilla is closed!

Wikimedia has migrated from Bugzilla to Phabricator. Bug reports should be created and updated in Wikimedia Phabricator instead. Please create an account in Phabricator and add your Bugzilla email address to it.
Wikimedia Bugzilla is read-only. If you try to edit or create any bug report in Bugzilla you will be shown an intentional error message.
In order to access the Phabricator task corresponding to a Bugzilla report, just remove "static-" from its URL.
You could still run searches in Bugzilla or access your list of votes but bug reports will obviously not be up-to-date in Bugzilla.
Bug 33524 - Jenkins: Publish error output of Doxyxgen
Jenkins: Publish error output of Doxyxgen
Status: RESOLVED FIXED
Product: Wikimedia
Classification: Unclassified
Continuous integration (Other open bugs)
unspecified
All All
: Normal enhancement (vote)
: ---
Assigned To: Krinkle
:
Depends on:
Blocks: documentation
  Show dependency treegraph
 
Reported: 2012-01-04 21:02 UTC by Tim Landscheidt
Modified: 2013-04-09 02:14 UTC (History)
2 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Tim Landscheidt 2012-01-04 21:02:01 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).
Comment 1 Sam Reed (reedy) 2012-01-04 21:25:57 UTC
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
Comment 2 Krinkle 2013-04-09 02:14:17 UTC
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:
   https://integration.wikimedia.org/ci/job/mediawiki-core-doxygen-publish/?

2) Sterr and stdout are written to files as build artificats,
   published on https://doc.wikimedia.org/mediawiki-core/master/php/

  Check https://doc.wikimedia.org/mediawiki-core/master/php/errors.txt
  for the most recent gathering of Doxygen warnings.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links