Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Warn on unescaped HTML-like markup #1300

Open
coryan opened this issue Dec 18, 2023 · 0 comments
Open

Warn on unescaped HTML-like markup #1300

coryan opened this issue Dec 18, 2023 · 0 comments
Labels
priority: p3 type: feature request

Comments

@coryan
Copy link

coryan commented Dec 18, 2023

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
priority: p3 type: feature request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@coryan