search

microsoft / vscode-cpptools

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

Support documentation block after members show `/<`, `!<` or `<` #5701

Open michelleangela opened 4 years ago

michelleangela commented 4 years ago

Fantastic! Another small detail - documentation block after members show /<, !< or < depending on chosen syntax. https://www.doxygen.nl/manual/docblocks.html#memberdoc

Originally posted by @ebinans in https://github.com/microsoft/vscode-cpptools/issues/658#issuecomment-649710505

georgev93 commented 11 months ago

I sure hope someone can get to this one soon!

georgev93 commented 11 months ago

Is the parsing of doxygen tags even handled by this extension? I see in src/LanguageServer/client.ts code to generate Doxygen comments in the code, but it looks like the tag parsing may happen elsewhere in vscode?

bobbrow commented 11 months ago

@georgev93 you are correct. The parsing happens in our language server which is not open source.

mrx23dot commented 3 months ago

Why not just show entire related comment when pointing to a member? Which is already happening image

so why would anyone need more? No point commenting A4 page amount of doxygen formated text, that's bad practice.

pirpyn commented 2 days ago

Why not just show entire related comment when pointing to a member? Which is already happening image

so why would anyone need more? No point commenting A4 page amount of doxygen formated text, that's bad practice.

FYI, this doesn't work if the comment is not on the same line as the declaration. But the doxygen syntax /*< or /!< is valid no matter the number of line breaks, blanck, or any whitespace character in between the declaration and the comment.