Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doxygen member groups support (///@{ ///@}) #13085

Open
myocytebd opened this issue Dec 28, 2024 · 0 comments
Open

doxygen member groups support (///@{ ///@}) #13085

myocytebd opened this issue Dec 28, 2024 · 0 comments
Assignees
Labels
Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Feature Request Language Service

Comments

@myocytebd
Copy link

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.

@browntarik browntarik added Feature Request Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Language Service labels Dec 30, 2024
@browntarik browntarik self-assigned this Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Doc comments An issue related to code comments shown in hover, completion, and signature help. Feature Request Language Service
Projects
Status: No status
Development

No branches or pull requests

2 participants