PDA

View Full Version : Creating documentation for own classes, that can be used in QtCreator's help system



Huk
18th September 2011, 11:59
Hello everyone.

First of all - sorry if I posted this in the wrong section of the forum, but I think this is the closest one there is to my problem.

I was wondering, is there a way to create documentation for my own classes, so that I could use it in QtCreator like the documentation for QT native classes? (I mean, I could click on class name and press "F1", and get detailed documentation).

Thanks in advance.

Lykurg
18th September 2011, 12:59
I haven't tried it so far, but look if that works: Document your code using Doxygen. Then generate a qhc file (Doxygen supports that). Add that qhc file to the creators help files (inside the settings dialog). Maybe then F1 works right out of the box.

Huk
18th September 2011, 18:51
@Lykurg:

Big thanks to You :)

I followed this guide:

http://doc.qt.nokia.com/qq/qq28-qthelp.html

then added the qhc file to QtCreator (Options->Help->Documentation->Add), and now I can use my doxygen documentation like the build in QT documentation :)

Thanks again.

Best regards.