microsoft / microsoft/vscode-cpptools

Docstring function preview misrenders bullet list when Doxygen annotation is involved

Open
#11,535 6 comments 31 reactions 1 assignee View on GitHub

@browntarik is already working on this.

Since Oct 17, 2023.

Feature Request Feature: Doc comments Language Service
Dominant language
TypeScript
Stars
6.2k
Forks
1.7k
Avg merge
14h 46m
Merged PRs (30d)
61

Description

Environment
  • OS and Version: macOS Sonoma 14.0
  • VS Code Version: 1.83.1
  • C/C++ Extension Version: v1.17.5
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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.