Repository navigation
Comment lines without Doxygen tags is not parsed correctly #5741
Description
This is reported on Visual Studio at
https://developercommunity.visualstudio.com/content/problem/1105383/comments-without-doxygen-tags-is-not-parsed-correc.html. Please upvote the Visual Studio feedback ticket to increase priority of issue as this feature is a shared API between Visual Studio C++ IntelliSense and the VS Code C++ extension.
Sample code:
/**
* Hello there
* blue sky.
*
* @return this is return note
*/
int test()
{
return 0;
}
Repro steps:
- In a C++ source, use the sample code provided.
- Hover over the function
test(). - Tooltip display result: “Hello thereblue sky”
Expected result in tooltip display:
“Hello there blue sky”
Note:
This issue only occurs when the comment has Doxygen tags.
Activity
[-]Comments without Doxygen tags is not parsed correctly[/-][+]Comment lines without Doxygen tags is not parsed correctly[/+]cinderblock commentedon Apr 3, 2021
When "Doxygen tags" are not used, is it also expected that single newlines get replaced with
<br />?michelleangela commentedon Apr 7, 2021
Cameron Tacklind (@cinderblock)
The space after the function name in the tooltip is not a replacement of single newlines from the comment, but the space is there to format the function name and comments with a space between them.
Here's an example with a one line comment
cinderblock commentedon Apr 7, 2021
Michelle Matias (@michelleangela) That's not what I'm referencing.
Do we not expect this to be displayed on one line?
As in, do the HTML whitespace rules only apply when using
@or/tags?Delgan commentedon Sep 30, 2021
Hi!
Just another example: I'm often using
\brief(or@brief, result is the same) then add a detailed description below (see Doxygen manual).However, as soon as the
\briefcommand is added, the newlines are removed from the tooltip which makes the documentation much less pleasant to read.Without the
\briefcommand Doxygen won't generate function summary in HTML.Sadly, that means we can't have the best of both worlds.
pclay614 commentedon Oct 8, 2021
Yes, it's incredibly frustrating that the doxygen parsing doesn't respect newlines and bulleted lists.
sean-mcmanus commentedon Nov 30, 2021
Fixed with https://github.com/microsoft/vscode-cpptools/releases/tag/1.8.0-insiders (the missing newline becomes a space).
austintraver commentedon Jan 30, 2022
Sean McManus (@sean-mcmanus) : Confirmed 👏🏻 upgrading from
1.7.1to the1.8.0insiders build fixed this issue for me.sean-mcmanus commentedon Oct 21, 2022
Did/can anyone file a feature request on VS to turn the space into a newline? They resolved the reported "bug" as "not a bug": https://developercommunity.visualstudio.com/t/Tooltips-are-not-showing-doxygen-comment/10087897