Results 1 to 6 of 6

Thread: Help document

  1. #1
    Join Date
    Mar 2009
    Location
    Gansu,China
    Posts
    188
    Qt products
    Qt4
    Platforms
    Windows

    Default Help document

    I have developed a software,How to make a help document such as Qt's ?

  2. #2
    Join Date
    May 2009
    Posts
    61
    Thanks
    5
    Thanked 6 Times in 6 Posts
    Qt products
    Qt3 Qt4
    Platforms
    MacOS X Unix/X11 Windows

    Default Re: Help document

    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.

  3. #3
    Join Date
    Feb 2009
    Location
    Noida, India
    Posts
    517
    Thanks
    21
    Thanked 66 Times in 62 Posts
    Qt products
    Qt3 Qt4
    Platforms
    Unix/X11 Windows

    Default Re: Help document

    do you have doxygen style commenting in the classes of your application?

  4. #4
    Join Date
    May 2009
    Posts
    61
    Thanks
    5
    Thanked 6 Times in 6 Posts
    Qt products
    Qt3 Qt4
    Platforms
    MacOS X Unix/X11 Windows

    Default Re: Help document

    Not for generating user's manuals, as the doxygen stuff explains how to use the classes, not the program's behaviour. Why?

  5. #5
    Join Date
    Feb 2009
    Location
    Noida, India
    Posts
    517
    Thanks
    21
    Thanked 66 Times in 62 Posts
    Qt products
    Qt3 Qt4
    Platforms
    Unix/X11 Windows

    Default Re: Help document

    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

  6. #6
    Join Date
    May 2009
    Posts
    61
    Thanks
    5
    Thanked 6 Times in 6 Posts
    Qt products
    Qt3 Qt4
    Platforms
    MacOS X Unix/X11 Windows

    Default Re: Help document

    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?

Similar Threads

  1. Replies: 0
    Last Post: 11th May 2009, 08:27
  2. Problems implementing Google Chrome's search
    By seand in forum Qt Programming
    Replies: 1
    Last Post: 14th September 2008, 04:11
  3. open a document
    By peace_comp in forum Qt Programming
    Replies: 5
    Last Post: 30th June 2008, 07:08
  4. can Qt open MS word document?
    By coder1985 in forum Qt Programming
    Replies: 1
    Last Post: 25th December 2007, 14:34
  5. Replies: 1
    Last Post: 1st February 2007, 14:32

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide.