Uploaded image for project: 'Qt Creator'
  1. Qt Creator
  2. QTCREATORBUG-6104

Show documentation in autocomplete popups

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Fixed
    • P3: Somewhat important
    • None
    • Qt Creator 2.3.0
    • None
    • All

    Description

      Currently, Qt Creator doesn't show documentation (or even the signature) when browsing through the list of functions/variables that appear in autocomplete. I'm referring to the list that pops up that when you do SomeClass. or SomePointer->). Some other code editors show the comments preceding the target definition and its signature. For example, I remember Eclipse showing Doxygen comments when I used it when I was a student. I seem to remember it showed even basic //comments as well.

      This would reduce the amount of time spent doing documentation look-ups, and therefore increase the enjoyment of using Qt Creator, as well as accelerating the learning rate. This is especially good for people who are new to Qt and/or C/C++ development.

      Since the Qt library isn't documented, it would only be useful for the user's custom classes at first, but it would be a step in the right direction. What should follow (i.e. a completely separate feature request to do in the future) is a documented Qt library, which probably isn't as bad as it sounds since the documentation is already there on the website and would only need to be inserted into the Qt source files.

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              kandeler Christian Kandeler
              machintrucchose Marwan Nader
              Votes:
              2 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes