Results 1 to 3 of 3

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

  1. #1
    Join Date
    Jul 2009
    Posts
    21
    Thanks
    1

    Default Creating documentation for own classes, that can be used in QtCreator's help system

    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.

  2. #2
    Join Date
    Jan 2006
    Location
    Germany
    Posts
    4,380
    Thanks
    19
    Thanked 1,005 Times in 913 Posts
    Qt products
    Qt4
    Platforms
    Unix/X11 Windows Symbian S60
    Wiki edits
    5

    Default Re: Creating documentation for own classes, that can be used in QtCreator's help syst

    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.

  3. The following user says thank you to Lykurg for this useful post:

    Huk (18th September 2011)

  4. #3
    Join Date
    Jul 2009
    Posts
    21
    Thanks
    1

    Default Re: Creating documentation for own classes, that can be used in QtCreator's help syst

    @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.

Similar Threads

  1. Having Trouble Creating Classes
    By jstippey in forum Newbie
    Replies: 2
    Last Post: 17th March 2011, 16:22
  2. Creating Library using QTCreator (hiddevice)
    By AlphaWolfXV in forum Qt Programming
    Replies: 0
    Last Post: 2nd February 2010, 14:02
  3. Trouble with plugin system's documentation
    By niklas in forum Qt Programming
    Replies: 8
    Last Post: 6th March 2009, 23:07
  4. creating a dylib for a plugin with external classes
    By themolecule in forum Qt Programming
    Replies: 4
    Last Post: 23rd July 2008, 15:22
  5. Adding Qt's documentation to Xcode documentation browser
    By fabietto in forum Qt Programming
    Replies: 0
    Last Post: 10th June 2007, 16:38

Tags for this Thread

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.