Warn on unescaped HTML-like markup

googleapis / api-linter

A linter for APIs defined in protocol buffers.

https://linter.aip.dev/

Apache License 2.0

583 stars 142 forks source link

Open coryan opened 9 months ago

coryan commented 9 months ago

Comments like this:

// Blah blah blah
// projects/<project>/regions/<region>

Can confuse the reference docs for C++. Doxygen considers <region> to be an unknown HTML markup element. The fix is to use a code span:

// Blah blah blah
// `projects/<project>/regions/<region>`

Which probably follows the style code.