microsoft / microsoft/vscode-cpptools

Full doxygen docs formatting listing each command

Open
#7,932 1 comment 5 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

Type: Feature Request

As of now, doxygen documentation in c/cpp headers is shown when hovering methods either in short form like with fancy formatted parameter list and stuff like so:
image
or fully showing each doxygen command with no formatting at all, like this:
image

Setting C_Cpp.simplifyStructuredComments in settings.json to true (former) or false (latter) controls this behaviour

Now, it would be nice to have a way to show full documentation of a method in a formatted way, showing each doxygen command (instead of cutting text abruptly before the next doxygen command) while retaining the fancy formatting, but as a third year computer engineering undergrad that has never touched a codebase that wasn't written by themselves I found the job of implementing it myself a bit overwhelming, so if you could consider either implementing this feature or pointing me in the right direction so that I can contribute and implement and push the feature myself that would be much appreciated.

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

Use the C_Cpp.simplifyStructuredComments setting as the entry point and trace how C/C++ doxygen comments are rendered in method hovers. Review the existing simplified and unsimplified behavior before deciding how a third formatted mode should work. Done means full doxygen command content is shown while preserving the existing formatted presentation, validated with representative C/C++ comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, cpp, typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.