microsoft / vscode-cpptools

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

Docstring function preview misrenders bullet list when Doxygen annotation is involved #11535

Open gnahtb opened 1 year ago

gnahtb commented 1 year ago

Environment

Bug Summary and Steps to Reproduce

Bug Summary:

Paragraphs are treated as one line when there is Doxygen annotation in the function docstring.

image image

Steps to reproduce:

Experiment with the code snippets in above images

Expected behavior:

In the second image, a bullet point list should appear instead of text being squashed into one line.

Configuration and Logs

Not applicable

Other Extensions

Not applicable

Additional context

No response

browntarik commented 1 year ago

This is by design, Doxygen comments are meant to enforce Doxygen formatting so anything outside of a tag will be formatted as one line with stripped whitespace. As of right now you cannot mix Doxygen and Markdown formatting in comments. If this is something you would like to see, please consider submitting a feature request.

browntarik commented 1 year ago

I have labeled this as a Feature Request for your convenience. Thank you!

gnahtb commented 1 year ago

Does the repo welcome contributors? I am happy to work on this.

github-actions[bot] commented 10 months ago

This feature request is being closed due to insufficient upvotes. Please leave a 👍-upvote or 👎-downvote reaction on the issue to help us prioritize it. When enough upvotes are received, this issue will be eligible for our backlog.

github-actions[bot] commented 7 months ago

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

gabeseltzer commented 1 month ago

To be clear, Doxygen does say it supports markdown lists