microsoft / microsoft/vscode-cpptools
Support Text emphasis with \b for Doxygen comments
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
Type: LanguageService
Describe the bug
- OS and Version: Ubuntu 18.04.5
- VS Code Version: 1.51.1
- C/C++ Extension Version: 1.1.3
This code snippet:
/// Does absolutely truly \b nothing
void f() {}
has nothing emphasized in VSCode editor, not in doxygen popup window:
Is this an expected behavior? Is there a way to format the text and add math equations in doxygen comments, so they are visible in popup windows?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the Doxygen comment from the issue in the C/C++ extension's language-service popup on VS Code. Compare the editor rendering with the popup rendering for the \b emphasis command, then check how the popup handles other Doxygen formatting and math equations. Done means the intended formatting behavior is established and the reported emphasis case is handled consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, typescript, vscode
- Domain
- developer-experience, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100