microsoft / microsoft/vscode-cpptools

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

Aperta
#13,085 2 commenti 9 reazioni 1 assegnatario Vedi su GitHub

@browntarik ci sta già lavorando.

Dal 30/12/2024.

Feature Request Feature: Doc comments Language Service
Lingua principale
TypeScript
Stelle
6.2k
Fork
1.7k
Merge medio
14h 46m
PR unite (30g)
61

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.