Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display additional Doxygen tags in tooltip documentation #12384

Closed
MikeWeller opened this issue Jun 17, 2024 · 4 comments
Closed

Display additional Doxygen tags in tooltip documentation #12384

MikeWeller opened this issue Jun 17, 2024 · 4 comments
Assignees
Labels
enhancement Improvement to an existing feature Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. fixed Check the Milestone for the release in which the fix is or will be available. Language Service quick fix
Milestone

Comments

@MikeWeller
Copy link

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
Copy link
Member

bobbrow commented Jun 17, 2024

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

@bobbrow bobbrow added this to the On Deck milestone Jun 17, 2024
@bobbrow bobbrow added Language Service quick fix Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. enhancement Improvement to an existing feature labels Jun 17, 2024
@bobbrow bobbrow added this to cpptools Jun 17, 2024
@bobbrow bobbrow moved this to Todo in cpptools Jun 17, 2024
@MikeWeller
Copy link
Author

@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
Copy link
Member

bobbrow commented Jun 18, 2024

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

image

@browntarik browntarik moved this from Todo to In progress in cpptools Jun 25, 2024
@browntarik browntarik moved this from In progress to Pull Request in cpptools Jun 25, 2024
@browntarik browntarik added the fixed Check the Milestone for the release in which the fix is or will be available. label Jun 26, 2024
@browntarik browntarik moved this from Pull Request to Done in cpptools Jun 26, 2024
@sean-mcmanus sean-mcmanus modified the milestones: On Deck, 1.21.1 Jul 6, 2024
@sean-mcmanus
Copy link
Contributor

@github-actions github-actions bot locked and limited conversation to collaborators Sep 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Improvement to an existing feature Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. fixed Check the Milestone for the release in which the fix is or will be available. Language Service quick fix
Projects
Status: Done
Development

No branches or pull requests

4 participants