QT Style Comments (Intellisense?)

I noticed in QTCreator 2.1 that they now have a kind of intellisense similar to Visual Studio. I know that intellisense is Microsoft's name for this concept of a useful tooltip that gives you a description of the method, parameters, etc. Therefore, I don’t know what is actually called. Does anyone know how to add these popup comments to methods and classes in QT?

To clarify again what I'm talking about is similar to javadoc or "///" comments in C #. I hope that QT developers will get the opportunity for users to make their own comments.

Thanks for the help,

Jec

+4
source share
1 answer

I also wanted to do this.

I found this topic on qtCentre.org, where someone integrated their own documents into QT Creator hints. I have not tested it myself, but that sounds reasonable:

http://www.qtcentre.org/archive/index.php/t-40324.html?s=98d48c38547da14b0725e5106d83c315

To use your own documentation in Qt Helper (and in Qt Creator help as well) you need to create a Qt compressed Help File (.qch (Http://doc.qt.nokia.com/4.7/assistant-custom-help-viewer. html # displaying-custom-documentation)) and register it in the Assistant and Creator. Doxygen has several tools specifically for Qt. It has config tags to help you create documentation exactly as you need. For instance. with the GENERATE_QHP tag, you can force it to create a ready-made qhp (Http://doc.qt.nokia.com/4.7/assistant-custom-help-viewer.html#creating-a-custom-help-collection-file) (Help file Qt) (you need this to generate .qch). If you do not need to edit this file manually before creating .qhc, you can set the QHG_LOCATION tag to the location of your qhelpgenerator.exe (usually here (on Windows): /mingw/bin/qhelpgenerator.exe) and it will generate ready-made documentation. Register it in Qt Helper (optional) and Creator and you're done. After that, all of your documented types, functions, members, etc. will have a tooltip with F1 button hint. And of course, pressing F1 will show your documentary help.

+1
source

All Articles