microsoft / microsoft/vscode-cpptools
Support Doxygen implicit brief comments
Open
Nobody has claimed this yet.
Feature Request
Feature: Doc comments
Language Service
Visual Studio
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
Issue Type: Bug
The documentation tooltip shows the !, which is part of the Doxygen comment syntax, not part of the description:
Extension version: 1.0.1
VS Code version: Code 1.49.2 (e5e9e69aed6e1984f7499b7af85b3d05f9a6883a, 2020-09-24T16:26:09.944Z)
OS version: Linux x64 4.15.0-118-generic
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
Reproduce the tooltip issue in the VS Code C/C++ extension using a Doxygen implicit brief comment, then trace how the comment text is parsed and displayed. Confirm the fix by checking that the Doxygen ! syntax marker is omitted from the documentation tooltip while the description remains visible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, typescript
- 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