Creating .qch files from Doxygen – Revisited

Published Thursday January 15th, 2009
4 Comments on Creating .qch files from Doxygen – Revisited
Posted in Documentation, doxygen2qthelp

In June 2008, I wrote about doxygen2qthelp and how to create Assistant-viewable content, i.e., Qt Compressed Help .qch files, from Doxygen. In this post, I would like to further elaborate on showing Doxygen generated documentation in Qt Assistant.

Later, I collaborated with Doxygen’s head developer, Dimitri van Heesch. As a result, Doxygen 1.5.7.1 introduced direct support for .qhp and indirect support for .qch (through qhelpgenerator). However, this did not work perfectly, but the Subversion repository contained a fix soon after.

The recently released Qt Quarterly 28 has an article that explains how to make Doxygen generate .qch and .qhp files for you, out of the box. This article is
titled “HTML Files and Help Projects” and is freely available online.

Doxygen 1.5.8 has now been released and it contains this fix. I’m aware that a few days have passed since December 27th, but I believe this news is still new for some.

So, to sum up:

That’s it, have a nice day.

Do you like this? Share it
Share on LinkedInGoogle+Share on FacebookTweet about this on Twitter

Posted in Documentation, doxygen2qthelp

4 comments

Ralf says:

Good job!
One suggestion, though: Would it be possible to add “File->Rescan Documentation” to assistant?
The documentation to be included is likely to be generated after each nightly build, so atm one has to quit and restart designer every morning…. Reloading/Rescanning would be highly appreciated.

Ralf

cbismuth says:

Hi Sebastian,

Thank you for this great post.
I wish a Qt Creator / Doxygen integration will be released, with a default doxygen configuration file from the Qt Creator team.

I’ll stay tuned ;o)
Chris

Philippe says:

I use to make the user manual it and it works great. I just wish there could be some keyword support too.

Ralf says:

Works fine, good job.

Two suggestions: We perform nightly builds of our software and create the documentation afterwards. Assistant does not detect that its documentation files have changed, so we are forced to quit and restart it. Couldn’t you add a Menu item “Rescan” or the like?

And: doxygen is now capable of indexing fortran files. The information is available in the HTML Output, but not in the qch. Is qthelpgenerator or doxygen itself suppressing this data?
It would be the optimum if we could get the Fortran information, too.

Anyway: Good job, thank you!

Ralf

Commenting closed.

Get started today with Qt Download now