microsoft / microsoft/vscode-cpptools

Doxygen alias support

Aperta
#12,752 2 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Type: Feature Request

This is similar (if not identical) to https://github.com/microsoft/vscode-cpptools/issues/5700 - adding support for Doxygen aliases like @par instead of @param, @input instead of @param[in] etc.

My use-case is probably unique, working on a large codebase documented with SourceDoc [2], an older source documenting tool that uses a syntax which overlaps a lot with Doxygen and can be parsed by Doxygen specific tools (including cpptools) with the appropiate aliases.
However, generic Doxygen alias support is probably not that rare and might help others too.

Ideally, aliases would allow setting the display name in the hover, but for the regular Doxygen parsing those seem to be localized, so that part might be tricky.

If aliases are hard to implement, maybe we could at least define our custom tags and their hover diplay name.

Disabling Simplify Structured Comments is not a viable alternative, the result is too much of paragraph soup to be intelligible, we cannot customize the sections to be filtered in the hover etc.

Code example:

/**
 * @function cpptools_test1
 * @brief desc for this void func.
 *
 * @input   p1    Input arg.
 * @output  p2    Output args.
 */
static void
cpptools_test1(void *p1, void *p2)
{
   (void)p1;
   (void)p2;
}

[1] https://www.doxygen.nl/manual/config.html#cfg_aliases
[2] https://sourceforge.net/projects/scdoc/

Extension version: 1.22.3
VS Code version: Code - Insiders 1.94.0-insider (4f485cf59847506bc1ba2aaab127d31dcbe2c9dc, 2024-09-18T09:24:10.356Z)
OS version: Windows_NT x64 10.0.22631
Modes:
Remote OS version: Linux x64 4.18.0-513.11.1.el8_9.0.1.x86_64

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.

Direzione di ricerca

La richiesta non identifica file di implementazione né test. Inizia esaminando la documentazione collegata sugli alias di Doxygen e l’esempio C fornito; chiarisci se sono richiesti alias, tag personalizzati e nomi visualizzati al passaggio del cursore, quindi verifica che tag come @input e @output vengano analizzati come previsto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Attiva
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.