googleapis / googleapis/api-linter
Warn on unescaped HTML-like markup
Open
priority: p3
type: feature request
- Dominant language
- Go
- Stars
- 765
- Forks
- 181
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 3
Description
Comments like this:
```
// Blah blah blah
// projects//regions/
```
Can confuse the reference docs for C++. Doxygen considers `` to be an unknown HTML markup element. The fix is to use a code span:
```
// Blah blah blah
// `projects//regions/`
```
Which probably follows the style code.
Contributor guide
Assessment
This issue has not been assessed yet.