googleapis / googleapis/google-cloud-cpp

Improve handling of unknown elements

Aperta
#13,911 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
cpp: docfx type: cleanup
Lingua principale
C++
Stelle
659
Fork
462
Merge medio
1g 2h
PR unite (30g)
89

Descrizione

When I implemented the docfx tool I skipped handling of most elements in a ``. There are about 300 of them:

https://github.com/doxygen/doxygen/blob/2717489cb90ffd338217b6ce6d2fcb38f25495e6/src/htmlentity.cpp#L40

And we only use about a dozen:

https://github.com/googleapis/google-cloud-cpp/blob/e6140c8884293ada510dd64288d4077afaa69c3a/docfx/doxygen2markdown.cc#L435-L456

The `docfx` tool intentionally crashes when it finds an element it does not know how to handle. That way we can update the code when needed. But maybe we should proactively add elements that we think may appear in the future and are safe to handle.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia in docfx/doxygen2markdown.cc, intorno alla gestione degli elementi alle righe 435-456, quindi confronta l’elenco più ampio degli elementi in src/htmlentity.cpp intorno alla riga 40. Individua gli elementi che è sicuro supportare in modo proattivo e conferma che lo strumento docfx gestisce tali elementi senza arrestarsi intenzionalmente; l’issue non indica alcun file di test.

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

Valutazione

Stack tecnologico
cpp
Ambito
documentation, tooling
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.