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.

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

Warning about <br> tag in title section #5182

Closed
albert-github opened this issue Jan 25, 2025 · 3 comments · Fixed by #5197
Closed

Warning about <br> tag in title section #5182

albert-github opened this issue Jan 25, 2025 · 3 comments · Fixed by #5197
Labels
type:Documentation Documentation improvement or change

Comments

@albert-github
Copy link
Contributor

Running the current doxygen master (1.14.0 (eef56fc1577255e67e56f997896b0512dd9527d1)) on the ITK sources resulted in a number warnings like:

warning: Unsupported HTML tag <br> found as part of a title section

Full list: html.txt

This can be easily prevented by removing the <br> from the ALIASES settings.

@albert-github albert-github added the type:Documentation Documentation improvement or change label Jan 25, 2025
@dzenanz
Copy link
Member

dzenanz commented Jan 27, 2025

I assume this is the place to do it?

set(DOXYGEN_ALIASES
"starteraliasnotused=@par not used"
"wiki=\\par Wiki Examples:<br> ^^ \\li <a href=\\\"https://www.itk.org/Wiki/ITK/Examples\\\">All Media Wiki Examples</a> ^^"
"wikiexample{2}= \\li <a href=\\\"https://www.itk.org/Wiki/ITK/Examples/\\1\\\">\\2</a> ^^"
"endwiki=^^ ^^ ^^"
"sphinx=\\par ITK Sphinx Examples:<br> ^^ \\li <a href=\\\"https://itk.org/ITKExamples\\\">All ITK Sphinx Examples</a> ^^"
"sphinxexample{2}=\\li <a href=\\\"https://itk.org/ITKExamples/src/\\1/Documentation.html\\\">\\2</a> ^^"
"endsphinx=^^ ^^ ^^")

@albert-github
Copy link
Contributor Author

@dzenanz
Yes that is the place

@albert-github
Copy link
Contributor Author

Proposed patch: diff.patch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Documentation Documentation improvement or change
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants