Results 1 to 16 of 16

Thread: how to document classes and member functions?

Hybrid View

Previous Post Previous Post   Next Post Next Post
  1. #1
    Join Date
    Jan 2006
    Location
    Napoli, Italy
    Posts
    621
    Thanks
    5
    Thanked 86 Times in 81 Posts
    Qt products
    Qt3 Qt4
    Platforms
    Unix/X11 Windows

    Default Re: how to document classes and member functions?

    If you want use Qt Creator, you must use Assistant integration.

    I think this is not so hard and can be usefull for developing big projects.
    A camel can go 14 days without drink,
    I can't!!!

  2. #2
    Join Date
    Mar 2011
    Posts
    13
    Thanks
    3
    Qt products
    Qt4
    Platforms
    Windows

    Default Re: how to document classes and member functions?

    Quote Originally Posted by mcosta View Post
    I think this is not so hard and can be usefull for developing big projects.
    Agree, but in any job there will always be types that have the same name, but different purposes in different projects (I'm talking about small classes, that doesn't mean to be used everywhere with same functionality). I'm almost sure there will be solutions for cases like this: to create fast, small, project-depended documentation (like with doxygen, but integrated in Qt Creator for specific project only).
    Anyway, your help was very useful. Thank you very much! If I find smth about this in future, I'll post it here for everyone.

  3. #3
    Join Date
    Mar 2011
    Posts
    13
    Thanks
    3
    Qt products
    Qt4
    Platforms
    Windows

    Default Re: how to document classes and member functions?

    Problem partly solved!

    To use your own documentation in Qt Assistant (and in Qt Creator help as well) you need to create Qt Compressed Help file (.qch) and register it in Assistant and Creator.
    Doxygen has several tools exactly for Qt. There are tags in it's config file, that help you to create the documentation exactly the way you need. E.g. with GENERATE_QHP tag you can make it create the ready qhp (Qt Help Project) file (you need this to generate the .qch). If you don't need to edit this file manually before creating the .qhc, you can set the value of QHG_LOCATION tag to the location of your qhelpgenerator.exe (usually it's here (in Windows): <QtPath>/mingw/bin/qhelpgenerator.exe) and it will generate the ready documentation. Register it in Qt Assistant (optional) and Creator and you're done.
    After this all your documented types, functions, members, etc. will have the tooltip with F1 button hint. And of course pushing F1 will show your documented help for it.

    Now the only problem remaining is to make Qt Creator to show also the brief descriptions. I've tried a lot but useless.. If anyone have an idea, please tell me.

  4. #4
    Join Date
    Jan 2006
    Location
    Napoli, Italy
    Posts
    621
    Thanks
    5
    Thanked 86 Times in 81 Posts
    Qt products
    Qt3 Qt4
    Platforms
    Unix/X11 Windows

    Default Re: how to document classes and member functions?

    Have you used "QT_AUTOBRIEF"???
    A camel can go 14 days without drink,
    I can't!!!

  5. #5
    Join Date
    Mar 2011
    Posts
    13
    Thanks
    3
    Qt products
    Qt4
    Platforms
    Windows

    Default Re: how to document classes and member functions?

    Quote Originally Posted by mcosta View Post
    Have you used "QT_AUTOBRIEF"???
    Yes, it didn't help

  6. #6
    Join Date
    Jan 2006
    Location
    Napoli, Italy
    Posts
    621
    Thanks
    5
    Thanked 86 Times in 81 Posts
    Qt products
    Qt3 Qt4
    Platforms
    Unix/X11 Windows

    Default Re: how to document classes and member functions?

    ok, I think this is a question for Qt Creator gurus (developer)
    A camel can go 14 days without drink,
    I can't!!!

  7. #7
    Join Date
    Mar 2011
    Posts
    13
    Thanks
    3
    Qt products
    Qt4
    Platforms
    Windows

    Default Re: how to document classes and member functions?

    Quote Originally Posted by mcosta View Post
    Qt Creator gurus (developer)
    are there any in this forum?

  8. #8
    Join Date
    Sep 2009
    Location
    UK
    Posts
    2,447
    Thanks
    6
    Thanked 348 Times in 333 Posts
    Qt products
    Qt4
    Platforms
    Windows

    Default Re: how to document classes and member functions?

    I don't think Qt supports project-specific help whilst you type, but there are IDEs that do, such as Netbeans, Visual Studio (with plugin) and possibly Eclipse. Netbeans being my current favorite, free, open source and easily extendable with Java.

  9. The following user says thank you to squidge for this useful post:

    jackal (8th April 2011)

  10. #9
    Join Date
    Jan 2006
    Location
    Napoli, Italy
    Posts
    621
    Thanks
    5
    Thanked 86 Times in 81 Posts
    Qt products
    Qt3 Qt4
    Platforms
    Unix/X11 Windows

    Default Re: how to document classes and member functions?

    I saw Qt Creator code and I understand (I hope) that it uses the index.
    A camel can go 14 days without drink,
    I can't!!!

  11. #10
    Join Date
    Mar 2011
    Posts
    13
    Thanks
    3
    Qt products
    Qt4
    Platforms
    Windows

    Default Re: how to document classes and member functions?

    Thank you for your help, guys! I think it's good idea to try Netbeans (I don't want new headaches about this any more right now). After I finish my current project, I'll try to find some solution to use native tooltips of Qt Creator. I'll let you know if I have any success.

  12. #11
    Join Date
    Mar 2011
    Posts
    13
    Thanks
    3
    Qt products
    Qt4
    Platforms
    Windows

    Default Re: how to document classes and member functions?

    Quote Originally Posted by jackal View Post
    I think it's good idea to try Netbeans
    NOPE! I didn't like it
    Qt Creator is really good. Don't wanna try another editor

Similar Threads

  1. Replies: 1
    Last Post: 16th March 2011, 08:10
  2. Replies: 5
    Last Post: 17th November 2010, 17:29
  3. Question about functions in classes
    By cwnelatury in forum Newbie
    Replies: 1
    Last Post: 13th May 2009, 06:05
  4. Pointers to Member Functions
    By Doug Broadwell in forum General Programming
    Replies: 8
    Last Post: 15th May 2007, 23:08
  5. emiting signals from const member functions !?
    By sunil.thaha in forum Qt Programming
    Replies: 2
    Last Post: 25th March 2006, 11:29

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
  •  
Qt is a trademark of The Qt Company.