PDA

View Full Version : Help document



weixj2003ld
17th May 2009, 11:07
I have developed a software,How to make a help document such as Qt's ?

auba
17th May 2009, 11:38
With Qt comes an example how to use the assistant interface to manage help (examples/assistant/simpletextviewer). Under documentation/, there are also example docs.

But I'd prefer to get the system locale's language (or country) and start a browser in doc/{lng}/documentation.html.

talk2amulya
17th May 2009, 12:22
do you have doxygen style commenting in the classes of your application?

auba
17th May 2009, 12:33
Not for generating user's manuals, as the doxygen stuff explains how to use the classes, not the program's behaviour. Why?

talk2amulya
17th May 2009, 12:51
go through any of Qt's source files..you'll find the comments in there are exactly whats written about them in Qt Assistant..Qt uses doxygen style commenting inside to produce documentation for all their classes which is then used in Qt Assistant

auba
17th May 2009, 13:04
Yes. Ok. I use this kind of comments, too. What exactly was now the basic question of this thread? How to display this help or how to generate it?