googleapis / googleapis/google-cloud-cpp
Improve handling of unknown elements
- Vorherrschende Sprache
- C++
- Sterne
- 659
- Forks
- 463
- Ø Merge
- 1 T. 2 Std.
- Gemergte PRs (30 T.)
- 89
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
Beginnen Sie in docfx/doxygen2markdown.cc bei der Elementbehandlung in den Zeilen 435-456 und vergleichen Sie anschließend die umfassendere Elementliste in src/htmlentity.cpp um Zeile 40. Identifizieren Sie Elemente, deren proaktive Unterstützung sicher ist, und bestätigen Sie, dass das docfx-Tool diese Elemente verarbeitet, ohne absichtlich abzustürzen; das Issue nennt keine Testdatei.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp
- Bereich
- documentation, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100