Qt Creator tools using Documentation Comments?

6thC · 15 Sept 2016, 08:09

Hello all,

I'm quite new to Qt and picking up lots and still discovering tools and stuff.

My ex ( Visual Studio ) had: https://msdn.microsoft.com/en-us/library/5ast78ax.aspx and excellent utilization of code documentation comments. Some example c# code from the internet:

/// <summary>
/// Assign selected cases to the participating users based on the filters and configurations
/// </summary>
/// <param name="noOfParticipants">No. of participants to the Table</param>
/// <param name="value">Value of the participant</param>
/// <returns>No Of Cases Assigned on successfull completion</returns>
public long AssignCasesToParticipatingUsers(int noOfParticipants,string value)
{

This was infinitely useful - just wondering what sort of tools for Intelligent code completion etc there is in Qt Creator, any 3rd party tools, etc? I found Dmitry Savchenko's \plugins\Todo4.dll which came bundled... anything else really useful like that?

kshegunov · 15 Sept 2016, 08:19

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

JKSH · wrote on 15 Sept 2016, 08:19

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

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

And here are the links:

mrjj · wrote on 15 Sept 2016, 08:22

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

6thC · 19 Sept 2016, 05:52

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.

JKSH · 6 6thC 19 Sept 2016, 05:26

@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")

6thC · 20 Sept 2016, 23:57

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!

JKSH · 21 Sept 2016, 06:06

@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 Kawa · 21 Sept 2016, 15:32

@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.

JKSH · wrote on 21 Sept 2016, 15:32

@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!

6thC · wrote on 22 Sept 2016, 00:39

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

6thC · wrote on 22 Sept 2016, 00:50

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...

6thC · wrote on 23 Sept 2016, 13:35

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/