microsoft / microsoft/vscode-cpptools

Support documentation block after members show `/<`, `!<` or `<`

Open
#5,701 5 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Fantastic! Another small detail - documentation block after members show /<, !< or < depending on chosen syntax.
https://www.doxygen.nl/manual/docblocks.html#memberdoc

Originally posted by @ebinans in https://github.com/microsoft/vscode-cpptools/issues/658#issuecomment-649710505

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.

Research direction

Read the linked Doxygen memberdoc documentation first, focusing on the supported documentation block forms after members: /\<, !\<, and \<. Identify the extension entry point that handles these syntax variants and verify that documentation blocks after members are recognized for each chosen syntax.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, typescript
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.