microsoft / microsoft/vscode-cpptools
Add support for doxygen `\copydoc` command
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
We sometimes use the \copydoc to not duplicate documentation when it is not needed. It would be great if the documentation of the mentioned symbol would be used for the tooltip.
Originally posted by @ben-edna in https://github.com/microsoft/vscode-cpptools/issues/658#issuecomment-652865472
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 reading the Doxygen documentation for the \copydoc command and tracing how the extension extracts documentation for tooltip display. Identify the existing documentation parsing and tooltip entry points, then verify that a symbol using \copydoc shows the referenced symbol's documentation in its tooltip.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100