Page MenuHomePhabricator

Jenkins: Publish error output of Doxyxgen
Closed, ResolvedPublic

Description

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).

Version: unspecified
Severity: enhancement

Details

Reference
bz33524
TitleReferenceAuthorSource BranchDest Branch
Use a more permissive regex in date selectionrepos/mediawiki/services/ipoid!215stranmain-I3c6c63c394a19976433b8d9c169b54e2010c936fmain
- Remove problematic condition when: alwaysrepos/ci-tools/sonarqube!7pwangaiskip_sonarmain
This allows one to skip sonar pipeline when there is (skip sonar) or (sonar skip) in the commentrepos/ci-tools/sonarqube!6pwangaiskip_sonarmain
Customize query in GitLab

Event Timeline

bzimport raised the priority of this task from to Medium.Nov 22 2014, 12:09 AM
bzimport set Reference to bz33524.

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: https://integration.wikimedia.org/ci/job/mediawiki-core-doxygen-publish/?
  1. 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.