Page MenuHomePhabricator

If an incompatible Doxygen version is used, disable the user manual (qch) generation
Closed, ResolvedPublic

Description

Using an incompatible Doxygen version can lead to build errors when creating the user manuals. We should force the CMake variable MITK_DOXYGEN_GENERATE_QCH_FILE to OFF if such cases.

Event Timeline

Should we only do this for doxygen versions which result in build errors or for all unsupported doxygen versions?

Currently the ones past 1.8.0 are broken, as in 1.8.3 and 1.8.5 (I believe) result in build errors, 1.8.1, .2 and .4 do build, but generate garbage. The versions before 1.8.0 will produce valid qt help files, but they will have a different layout/structure from the one we want.

I just tested 1.8.6 and it seems to work fine, at least using Windows.

Qch generation with 1.8.6 works fine, but when building the 'doc' target I get a lot of dot errors, I will investigate.

(In reply to Caspar Jonas Goch from comment #1)

Should we only do this for doxygen versions which result in build errors or
for all unsupported doxygen versions?

I would have taken the pragmatic approach and always disable the help generation of Doxygen version != 1.8.0. If you would like to check and maintain several versions, the decision is up to you ;-)

Seems to me the dot errors stem from the fact, that I do not have dot installed. Prior versions of doxygen just gracefully ignored that fact. The errors seem to happen at every place where dot is called.

A quick click-around in the html output suggests it works fine even with the generated errors.

I would suggests disabling the help generation for doxygen versions > 1.8.0 && < 1.8.6 . We then might want to consider updating to 1.8.6.

Further note: The dot error messages appear, even though HAVE_DOT is set to NO. Investigating.

User zelzer has pushed new remote branch:

bug-16886-improve-verification-of-doxygen-version

[4dff19]: Merge branch 'bug-16886-improve-verification-of-doxygen-version'

Merged commits:

2014-03-19 02:03:57 Sascha Zelzer [0223af]
Improved Doxygen version diagnostics and reporting.

[cb5a39]: Merge branch 'bug-16886-improve-verification-of-doxygen-version'

Merged commits:

2014-03-20 21:23:25 Sascha Zelzer [dac7b9]
If doxygen is not available, disable qch file generation.

Current release is finished. Resetting target milestone