Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. Qt Creator and other tools
  4. Qt Creator tools using Documentation Comments?
Forum Updated to NodeBB v4.3 + New Features

Qt Creator tools using Documentation Comments?

Scheduled Pinned Locked Moved Qt Creator and other tools
13 Posts 5 Posters 7.5k Views 4 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • kshegunovK kshegunov

    Hi,
    Qt Creator supports doxy/qdoc syntax out of the box.

    JKSHJ Offline
    JKSHJ Offline
    JKSH
    Moderators
    wrote on last edited by
    #3

    @kshegunov said in Qt Creator tools using Documentation Comments?:

    Qt Creator supports doxy/qdoc syntax out of the box.

    And here are the links:

    • Doxygen: https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
    • qdoc: http://doc.qt.io/qt-5/01-qdoc-manual.html

    Qt Doc Search for browsers: forum.qt.io/topic/35616/web-browser-extension-for-improved-doc-searches

    1 Reply Last reply
    1
    • mrjjM Offline
      mrjjM Offline
      mrjj
      Lifetime Qt Champion
      wrote on last edited by
      #4

      As a note, i would also point to the refactor menu. Lots of goodies.
      http://doc.qt.io/qtcreator/creator-editor-refactoring.html
      :)

      1 Reply Last reply
      1
      • 6thC6 Offline
        6thC6 Offline
        6thC
        wrote on last edited by
        #5

        Thanks guys, I did see Doxygen and qdoc but I'm not really interested in actual documents. It's out of date almost as soon as it's created. I'm also the only developer currently.

        Mainly looking for like my links: IDE integrated intellisense for my objects. It'd be awesome if we had tools to interrogate objects with a mouse over just like VS too. The Creator local objects seems a little lacking - hopefully that will improve.

        Re:Refactoring - thanks MrJJ - that link is close / what I'm thinking! Productivity tools etc. seems there's a bit there I haven't seen yet.
        I have found things like moving code lines, renaming symbols useful.

        I've also found http://cppcheck.sourceforge.net/ and am now using the Qt plugin and that - my god - this tool is invaluable.
        Very cool - should be bundled imo.

        Thanks again guys. I appreciate your efforts, I haven't found exactly what I'm after yet but this is quite workable.

        JKSHJ 1 Reply Last reply
        0
        • 6thC6 6thC

          Thanks guys, I did see Doxygen and qdoc but I'm not really interested in actual documents. It's out of date almost as soon as it's created. I'm also the only developer currently.

          Mainly looking for like my links: IDE integrated intellisense for my objects. It'd be awesome if we had tools to interrogate objects with a mouse over just like VS too. The Creator local objects seems a little lacking - hopefully that will improve.

          Re:Refactoring - thanks MrJJ - that link is close / what I'm thinking! Productivity tools etc. seems there's a bit there I haven't seen yet.
          I have found things like moving code lines, renaming symbols useful.

          I've also found http://cppcheck.sourceforge.net/ and am now using the Qt plugin and that - my god - this tool is invaluable.
          Very cool - should be bundled imo.

          Thanks again guys. I appreciate your efforts, I haven't found exactly what I'm after yet but this is quite workable.

          JKSHJ Offline
          JKSHJ Offline
          JKSH
          Moderators
          wrote on last edited by
          #6

          @6thC said in Qt Creator tools using Documentation Comments?:

          Mainly looking for like my links: IDE integrated intellisense for my objects.

          Do you mean automatic code completion? If your class definition is visible at the current scope, then you should get auto-completion for your object variables.

          It'd be awesome if we had tools to interrogate objects with a mouse over just like VS too.

          If you mouse over a variable/function in your code and press F2, you will be taken to its definition. (Not quite the same as interrogation, but very handy nonetheless)

          The Creator local objects seems a little lacking - hopefully that will improve.

          (Not sure what you meant by "Creator local objects")

          Qt Doc Search for browsers: forum.qt.io/topic/35616/web-browser-extension-for-improved-doc-searches

          1 Reply Last reply
          0
          • 6thC6 Offline
            6thC6 Offline
            6thC
            wrote on last edited by
            #7

            My head knows what I mean :-) - forgive me - my computer only does what I say not what I want/mean too!

            Auto-completion works fine :-) I meant interrogate while debugging. So I guess not intellisense but I don't know what to call it. Sorry.

            If I hover over an object "so" instance of say SomeObject, all the IDE tooltip does is tell me the class type "SomeObject". Which is uesful a little: It'd be more useful to expand/explode that object out and let me walk the state of it's data-members and stuff - like the local watch window.

            F2... that is cool. Thanks, that's nice to have! I'm loving using Qt and Qt Creator ... I'm just trying to get the most out of it and maybe get enhancements. I'm aware I'm the noob here haha. Thanks again!

            JKSHJ 1 Reply Last reply
            0
            • 6thC6 6thC

              My head knows what I mean :-) - forgive me - my computer only does what I say not what I want/mean too!

              Auto-completion works fine :-) I meant interrogate while debugging. So I guess not intellisense but I don't know what to call it. Sorry.

              If I hover over an object "so" instance of say SomeObject, all the IDE tooltip does is tell me the class type "SomeObject". Which is uesful a little: It'd be more useful to expand/explode that object out and let me walk the state of it's data-members and stuff - like the local watch window.

              F2... that is cool. Thanks, that's nice to have! I'm loving using Qt and Qt Creator ... I'm just trying to get the most out of it and maybe get enhancements. I'm aware I'm the noob here haha. Thanks again!

              JKSHJ Offline
              JKSHJ Offline
              JKSH
              Moderators
              wrote on last edited by
              #8

              @6thC said in Qt Creator tools using Documentation Comments?:

              My head knows what I mean :-) - forgive me - my computer only does what I say not what I want/mean too!

              That's pretty common, not to worry ;-)

              Auto-completion works fine :-) I meant interrogate while debugging. So I guess not intellisense but I don't know what to call it. Sorry.

              If I hover over an object "so" instance of say SomeObject, all the IDE tooltip does is tell me the class type "SomeObject". Which is uesful a little: It'd be more useful to expand/explode that object out and let me walk the state of it's data-members and stuff - like the local watch window.

              So you mean interactive tooltips that can expand to show the object's internal variables? Qt Creator doesn't have that, but it does have the window that shows everything in scope (http://doc.qt.io/qtcreator/creator-debug-mode.html#locals-and-expressions )

              You can submit feature a feature request to https://bugreports.qt.io/

              F2... that is cool. Thanks, that's nice to have! I'm loving using Qt and Qt Creator ... I'm just trying to get the most out of it and maybe get enhancements. I'm aware I'm the noob here haha. Thanks again!

              You're welcome. Happy exploring!

              (This is a place for newbies and oldies alike -- we make no distinction)

              @6thC said in Qt Creator tools using Documentation Comments?:

              I found Dmitry Savchenko's \plugins\Todo4.dll which came bundled... anything else really useful like that?

              I missed this line before. In Qt Creator, click Help -> About Plugins... to see (and select) a list of available plugins.

              Qt Doc Search for browsers: forum.qt.io/topic/35616/web-browser-extension-for-improved-doc-searches

              Chris KawaC 1 Reply Last reply
              0
              • JKSHJ JKSH

                @6thC said in Qt Creator tools using Documentation Comments?:

                My head knows what I mean :-) - forgive me - my computer only does what I say not what I want/mean too!

                That's pretty common, not to worry ;-)

                Auto-completion works fine :-) I meant interrogate while debugging. So I guess not intellisense but I don't know what to call it. Sorry.

                If I hover over an object "so" instance of say SomeObject, all the IDE tooltip does is tell me the class type "SomeObject". Which is uesful a little: It'd be more useful to expand/explode that object out and let me walk the state of it's data-members and stuff - like the local watch window.

                So you mean interactive tooltips that can expand to show the object's internal variables? Qt Creator doesn't have that, but it does have the window that shows everything in scope (http://doc.qt.io/qtcreator/creator-debug-mode.html#locals-and-expressions )

                You can submit feature a feature request to https://bugreports.qt.io/

                F2... that is cool. Thanks, that's nice to have! I'm loving using Qt and Qt Creator ... I'm just trying to get the most out of it and maybe get enhancements. I'm aware I'm the noob here haha. Thanks again!

                You're welcome. Happy exploring!

                (This is a place for newbies and oldies alike -- we make no distinction)

                @6thC said in Qt Creator tools using Documentation Comments?:

                I found Dmitry Savchenko's \plugins\Todo4.dll which came bundled... anything else really useful like that?

                I missed this line before. In Qt Creator, click Help -> About Plugins... to see (and select) a list of available plugins.

                Chris KawaC Offline
                Chris KawaC Offline
                Chris Kawa
                Lifetime Qt Champion
                wrote on last edited by Chris Kawa
                #9

                @JKSH said in Qt Creator tools using Documentation Comments?:

                So you mean interactive tooltips that can expand to show the object's internal variables? Qt Creator doesn't have that

                Actually it does: Showing Tooltips in Debug Mode.
                Tooltips are disabled by default so you need to enable them explicitly in the options.

                JKSHJ 1 Reply Last reply
                3
                • Chris KawaC Chris Kawa

                  @JKSH said in Qt Creator tools using Documentation Comments?:

                  So you mean interactive tooltips that can expand to show the object's internal variables? Qt Creator doesn't have that

                  Actually it does: Showing Tooltips in Debug Mode.
                  Tooltips are disabled by default so you need to enable them explicitly in the options.

                  JKSHJ Offline
                  JKSHJ Offline
                  JKSH
                  Moderators
                  wrote on last edited by
                  #10

                  @Chris-Kawa said in Qt Creator tools using Documentation Comments?:

                  @JKSH said in Qt Creator tools using Documentation Comments?:

                  So you mean interactive tooltips that can expand to show the object's internal variables? Qt Creator doesn't have that

                  Actually it does: Showing Tooltips in Debug Mode.
                  Tooltips are disabled by default so you need to enable them explicitly in the options.

                  I learn something new every day. Thanks for the tip!

                  Qt Doc Search for browsers: forum.qt.io/topic/35616/web-browser-extension-for-improved-doc-searches

                  1 Reply Last reply
                  0
                  • 6thC6 Offline
                    6thC6 Offline
                    6thC
                    wrote on last edited by 6thC
                    #11

                    My man! @Chris-Kawa - That's exactly what I wanted!

                    Thanks both of you, yes, this is exactly the sort of things I wanted to know

                    1 Reply Last reply
                    0
                    • 6thC6 Offline
                      6thC6 Offline
                      6thC
                      wrote on last edited by
                      #12

                      Oooh. I see now, mine was already default selected but you have to expand the object in the watch window before the tooltips seem to work... I think I'll log that as a bug/feature request so tooltips don't rely on you already going to the watch window...

                      1 Reply Last reply
                      1
                      • 6thC6 Offline
                        6thC6 Offline
                        6thC
                        wrote on last edited by
                        #13

                        Well. not even a day later and we have a patch going through review. I'm thoroughly impressed:
                        https://codereview.qt-project.org/#/c/171908/

                        1 Reply Last reply
                        0

                        • Login

                        • Login or register to search.
                        • First post
                          Last post
                        0
                        • Categories
                        • Recent
                        • Tags
                        • Popular
                        • Users
                        • Groups
                        • Search
                        • Get Qt Extensions
                        • Unsolved