vscode-cpptools icon indicating copy to clipboard operation
vscode-cpptools copied to clipboard

Customizable Doxygen tags for Quick Info

Open emaschas opened this issue 3 years ago • 12 comments

Type: Feature Request

Could you please implement @details and eventually also @note and @warning in quick info. If it cannot be a separate section, at least show the text after that of @brief.

Another suggestion : implement @n to force line break

Many thanks.

emaschas avatar Dec 11 '21 17:12 emaschas

@emaschas

Just to clarify, is this a request to add those additional Doxygen tags to the simplified view of structured comments in the quick info tooltip? Otherwise, all Doxygen tags can be viewed by setting C_Cpp.simplifyStructuredComments to false.

image

michelleangela avatar Dec 13 '21 19:12 michelleangela

The request is to add one or two more tags that would be displayed in the quick info with the same aspect as the "simplified" option. Something like that image

Maybe I should have done a separate issue for the other request concerning the implementation of @n to force line break (like
in HTML).

emaschas avatar Dec 14 '21 18:12 emaschas

I realize that my issue somehow similar to #7705

emaschas avatar Dec 15 '21 11:12 emaschas

This feature request is being closed due to insufficient upvotes. When enough upvotes are received, this issue will be eligible for our backlog.

github-actions[bot] avatar Feb 13 '22 11:02 github-actions[bot]

This feature request has received enough votes to be added to our backlog.

github-actions[bot] avatar Feb 13 '22 12:02 github-actions[bot]

@emaschas

Just to clarify, is this a request to add those additional Doxygen tags to the simplified view of structured comments in the quick info tooltip? Otherwise, all Doxygen tags can be viewed by setting C_Cpp.simplifyStructuredComments to false.

image

The problem is that with this setting being off comments become almost plain text, and tags are visible as tags with @ and all. So yeah, adding some tag being parsed would be great

Also, maybe add an option to parse known tags and just add the unknown ones as a non-simplified version?

TomasVaner avatar Jul 27 '22 22:07 TomasVaner

@emaschas Just to clarify, is this a request to add those additional Doxygen tags to the simplified view of structured comments in the quick info tooltip? Otherwise, all Doxygen tags can be viewed by setting C_Cpp.simplifyStructuredComments to false. image

The problem is that with this setting being off comments become almost plain text, and tags are visible as tags with @ and all. So yeah, adding some tag being parsed would be great

Also, maybe add an option to parse known tags and just add the unknown ones as a non-simplified version?

The request was to add some of the Doxygen tags in order to enhance the quick info tooltip, not the full set. The use case is not for Doxygen implementation, but just the quick info. The implementation of @n to force line breaks would be really nice too.

emaschas avatar Aug 22 '22 11:08 emaschas

@bobbrow Can/should you update the Milestone/Project?

sean-mcmanus avatar Aug 23 '22 18:08 sean-mcmanus

@sean-mcmanus we will when we start working on it.

bobbrow avatar Aug 23 '22 18:08 bobbrow

g11 I need ...

cjr163 avatar Aug 31 '22 09:08 cjr163

@cjr163 Could you clarify your screenshot/comment? What do you need?

sean-mcmanus avatar Sep 01 '22 17:09 sean-mcmanus

Since this was closed as a duplicate of #7705 I'd just like to add that I think even if the simplified display can be customized, @warning should be in the defaults

kisielk avatar Sep 14 '22 04:09 kisielk

image

michelleangela avatar Oct 10 '22 21:10 michelleangela

The fix is available with 1.13.3 (pre-release): https://github.com/microsoft/vscode-cpptools/releases/tag/v1.13.3

sean-mcmanus avatar Oct 26 '22 22:10 sean-mcmanus