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

Incorrect closing HTML comment #7700

Merged
merged 1 commit into from
Sep 13, 2023

Conversation

albert-github
Copy link
Contributor

Newer versions of doxygen are more restrictive (and following the rules) in respect to the end comment of a HTML type of comment, i.e. <!-- ... -->, so parts of the paragraphs were missing (Triangulation/index.html and Triangulation/group___pkg_triangulations_ref.html)

See also https://www.w3.org/TR/2006/REC-xml11-20060816/#sec-comments

Newer versions of doxygen are more restrictive (and following the rules) in respect to the end comment of a HTML type of comment, i.e. `<!-- ... -->`, so parts of the paragraphs were missing
(Triangulation/index.html and Triangulation/group___pkg_triangulations_ref.html)

See also https://www.w3.org/TR/2006/REC-xml11-20060816/#sec-comments
albert-github added a commit to albert-github/cgal that referenced this pull request Sep 7, 2023
Remove gray background and get some indentation
(Note this proposed pull request needs the proposed pull request CGAL#7700)
@afabri
Copy link
Member

afabri commented Sep 11, 2023

Don't we run an html-checker?

@albert-github
Copy link
Contributor Author

Don't we run an html-checker?

I don't think a HTML checker would be of any use here as the mentioned code is interpreted by doxygen and doxygen follows, now, the rule about the -->. So doxygen already filters the input and the offending code does not land in the HTML output at all.
(might be an idea that doxygen would give a warning when it encounters the forbidden construct --->)

@albert-github
Copy link
Contributor Author

Create a proposed pull request for doxygen: doxygen/doxygen#10298

@sloriot
Copy link
Member

sloriot commented Sep 13, 2023

Successfully tested in CGAL-6.0-Ic-61

@lrineau lrineau self-assigned this Sep 13, 2023
@lrineau lrineau added this to the 6.0-beta milestone Sep 13, 2023
@lrineau lrineau added the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Sep 13, 2023
@lrineau lrineau merged commit 63aa411 into CGAL:master Sep 13, 2023
8 checks passed
@lrineau lrineau deleted the feature/bug_html_comment branch September 13, 2023 14:18
@lrineau lrineau removed the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants