microsoft / microsoft/vscode-cpptools
doxygen member groups support (///@{ ///@})
Open
@browntarik is already working on this.
Since Dec 30, 2024.
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
Feature Request
doxygen Member Groups can populate some doc to every member of the group, and have a group name and group description.
https://www.doxygen.nl/manual/grouping.html#memgroup
///@{
/** Same documentation for both members. Details */
void func1InGroup1();
void func2InGroup1();
///@}
/** @name Group2
* Description of group 2.
*/
///@{
/** Function 2 in group 2. Details. */
void Memgrp_Test::func2InGroup2() {}
/** Function 1 in group 2. Details. */
void Memgrp_Test::func1InGroup2() {}
///@}
Member Groups is used in some popular libraries, e.g. libstdc++, llvm, ffmpeg headers.
Currently, cpptools doesn't recognize @{ patterns and treats them as regular comments.
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.
Assessment
This issue has not been assessed yet.