Results 1 to 7 of 7

Thread: Doxygen and Qt Classes

  1. #1
    Join Date
    Nov 2006
    Posts
    41
    Thanks
    5
    Qt products
    Qt4
    Platforms
    Unix/X11 Windows

    Default Doxygen and Qt Classes

    Hi there, i have just installed Doxygen v 1.5 and also graphviz as dot, however i dont know how to properly build documentation that includes the Qt classes i use in my app, by example i cant see inheritance from QDialog or QWidget in the class diagram it generates, how can i do this?

    thanks

  2. #2
    Join Date
    Jan 2006
    Location
    Warsaw, Poland
    Posts
    33,359
    Thanks
    3
    Thanked 5,015 Times in 4,792 Posts
    Qt products
    Qt3 Qt4 Qt5 Qt/Embedded
    Platforms
    Unix/X11 Windows Android Maemo/MeeGo
    Wiki edits
    10

    Default Re: Doxygen and Qt Classes

    Why do you need such a thing? It should be a documentation of your application, not Qt. As Qt is object oriented, you shouldn't care that QDialog inherits QWidget. I guess that if you really wanted that, you'd have to make Doxygen parse all Qt header files and as a result you'd get a documentation of both your program and Qt mixed up.

  3. #3
    Join Date
    Feb 2006
    Posts
    26
    Thanked 2 Times in 1 Post
    Qt products
    Qt3
    Platforms
    Unix/X11 Windows

    Default Re: Doxygen and Qt Classes

    I agree, the doc for Qt already exists, so it should be a part of your doc.

    On the other hand, you may want to clearly show which classes inherit your own (especially in generated schemas). If you're still sure it is what you want, try adding the 'include' directory of your Qt installation in the list of computed directories in doxygen, it should work.

  4. #4
    Join Date
    Nov 2006
    Posts
    41
    Thanks
    5
    Qt products
    Qt4
    Platforms
    Unix/X11 Windows

    Default Re: Doxygen and Qt Classes

    Uhm well it's just that my OOP teacher wants to see the inheritance but i guess if im composing my class with pushbuttons, labels and line edits it should be somewhere in the class diagram as composition isn't it?

  5. #5
    Join Date
    Jan 2006
    Location
    Warsaw, Poland
    Posts
    33,359
    Thanks
    3
    Thanked 5,015 Times in 4,792 Posts
    Qt products
    Qt3 Qt4 Qt5 Qt/Embedded
    Platforms
    Unix/X11 Windows Android Maemo/MeeGo
    Wiki edits
    10

    Default Re: Doxygen and Qt Classes

    I guess your teacher wants to see the inheritance in your code, not it Qt code.

  6. #6
    Join Date
    Nov 2006
    Posts
    41
    Thanks
    5
    Qt products
    Qt4
    Platforms
    Unix/X11 Windows

    Default Re: Doxygen and Qt Classes

    ehm not really, he just wants to see which class i inherit from to build my own Dialog by example 'cause it could be a QWidget or if i inherit from a QAbstractX or a QXWidget, etc. not show the whole Qt class members, also for sequence diagrams the signals must be present 'cause are like messages to the same or other class isnt it? and maybe the signal is inherited by a Qt class, a class not present in the class diagram? well this last is not doxygen business anyway

    sooo i guess i have to build the class diagram myself and have doxygen for complement documentation

  7. #7
    Join Date
    Nov 2006
    Posts
    41
    Thanks
    5
    Qt products
    Qt4
    Platforms
    Unix/X11 Windows

    Default Re: Doxygen and Qt Classes

    Nice i got the solution i can do this with Doxytag so i can see the Qt classes i use in the documentation Doxygen generates
    Use of Doxytag

Similar Threads

  1. doxygen config like qt docs
    By danadam in forum General Discussion
    Replies: 1
    Last Post: 3rd September 2006, 18:10

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.