search

microsoft / vscode-cpptools

Official repository for the Microsoft C/C++ extension for VS Code.
Other
5.4k stars 1.51k forks source link

Display additional Doxygen tags in tooltip documentation #12384

Open MikeWeller opened 2 weeks ago

MikeWeller commented 2 weeks ago

Feature Request

It looks like VSCode only shows a certain subset of Doxygen tags/commands in the tooltip documentation, e.g. \param, \note are rendered, while others are not.

In particular I would also like @pre (or \pre) (preconditions) to be visible. I see these as more important than @note which is currently displayed. In general it would be nice for all tags to be rendered in some way (though there may need to be a list defined somewhere to determine how multiple tags of the same name are combined into a list vs. not, for example).

Another tag I would like visible is @see, e.g. @see fooNon() for a version of this method that does not frob its input

bobbrow commented 2 weeks ago

We allow you to select which tags you'd like to see in the structured comment tooltip if you'd like to see additional tags beyond the ones we chose as the defaults.

Can you try adding those tags to the "C_Cpp.doxygen.sectionTags" setting? It looks like we don't recognize "see" yet so no special header will be added to the tooltip, but we can use this issue as a reminder to add it.

image image

MikeWeller commented 2 weeks ago

@bobbrow ah, great! Yes this solves the issue with pre, so for me this is now a relatively minor issue with see not being recognized (and I guess there may be other official commands in https://doxygen.nl/manual/commands.html that people would want, though I haven't reviewed the list)

bobbrow commented 1 week ago

You can also try setting "C_Cpp.simplifyStructuredComments" to false and it will do a more generic listing of all tags.

image