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. How To Make Comments in Qt's Intellisense?
Forum Updated to NodeBB v4.3 + New Features

How To Make Comments in Qt's Intellisense?

Scheduled Pinned Locked Moved Qt Creator and other tools
4 Posts 3 Posters 4.2k Views 1 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.
  • J Offline
    J Offline
    jecjackal
    wrote on last edited by
    #1

    A feature of netbeans and visual studio is the ability to make your own comments for your subroutines/classes. An example syntax for this is shown below

    netbeans (Java)

    @/**

    • This function does something
    • @param a the value of the input.
      */

    public void setInput(int a) { };
    @
    Visual Studio (C#)
    @///
    This function does something
    /param a the value of the input
    ///
    public void setInput(int a) { };@

    So if either of these two IDEs were used approximately like I showed above (syntax?) the developer would see the comment "the value of the input" when a is bold in the intellisense (current parameter being typed). The other form of this occurs when the mouse is hovered over a subroutine's name. In that case "This function does something" is displayed underneath the function's signature in the tooltip.

    Does QtCreator support anything like this? I noticed the Doyxgen tags are recognized but they don't seem to do anything. If QtCreator doesn't I think this should be added to a wish list.

    Thank you for your time.

    Jec

    1 Reply Last reply
    0
    • F Offline
      F Offline
      Franzk
      wrote on last edited by
      #2

      Creator doesn't automagically generate the documentation for you. The qdoc tags are recognized as you saw (doxygen is a qdoc clone) and you can use qdoc to generate help for creator. Check the "bug tracker":http://bugreports.qt.nokia.com for similar issues. If none exist, throw in a feature request :).

      "Horse sense is the thing a horse has which keeps it from betting on people." -- W.C. Fields

      http://www.catb.org/~esr/faqs/smart-questions.html

      1 Reply Last reply
      0
      • J Offline
        J Offline
        jecjackal
        wrote on last edited by
        #3

        I'm not exactly looking to generate documentation in the manner QDoc does. I just like the ability to write small comments (like in javadocs) and have them show up in the "intellisense". Now even though i mentioned javadocs, i'm not using the HTML portion of those (when i did java). I just used the intellisense portion.

        Thanks anyway. Here's hoping some day it will make it into QTCreator.

        1 Reply Last reply
        0
        • A Offline
          A Offline
          andre
          wrote on last edited by
          #4

          Whishes uttered on this forum will probably get lost. If you want to submit a feature request, use "Jira":http://bugreports.qt.nokia.com instead.

          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