[Qt-creator] How to provide Doxygen-style documentation to QtCreator Help

Ziller Eike Eike.Ziller at digia.com
Thu Dec 19 15:45:48 CET 2013


On Dec 19, 2013, at 2:50 PM, David Kaspar <dkaspar at blackberry.com> wrote:

> Hi,
> 
> We are having a set of libraries that provide C++ and QML API. The 
> documentation of those libraries are written in Doxygen style. We would 
> like to integrate this documentation into QtCreator, so it would be 
> available to  QtCreator Help, Qt Assistant and features. Is it possible 
> to implement a QtCreator plugin or use any conversion tool that would 
> allow us to feed this Doxygen-style documentation to QtCreator?
> 
> Right now I see that I would have to "manually" create mylib.qhp file 
> for each library and then run "qhelpgenerator mylib.qhp" to generate 
> .qch files that is used by QtCreator. Is there any other/better way to 
> do it?

Doxygen can do it:

http://www.stack.nl/~dimitri/doxygen/manual/config.html

See the QHP, QHG and QCH tags.

Br, Eike

-- 
Eike Ziller, Senior Software Engineer - Digia, Qt
 
Digia Germany GmbH, Rudower Chaussee 13, D-12489 Berlin
Geschäftsführer: Mika Pälsi, Juha Varelius, Tuula Haataja
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B




More information about the Qt-creator mailing list