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

Correction of (X)HTML warnings in case of Advanced topics #3758

Merged
merged 2 commits into from
Mar 19, 2019

Conversation

albert-github
Copy link
Contributor

Summary of Changes

Based on #3713 a number of problems were solved, but also some new issues introduced.

  • BaseDoxyfile.h see to it that the CGALAdvancedBegin is in a detailed part, so be sure to terminate the brief part by an extra carriage return
  • commands like \pre, \note read till the beginning of the next section but a \htmlonly is not seen as a section separator, so insert an extra carriage return
  • some places missed an "Advanced" indicator, used the cgalAdvancedType here.

Note

in Periodic_2_triangulation_2.h there appear to be a number of images that are a bit in thin air (Captions: "Insertion of a point on an edge." and "Insertion in a face.").
Also just above these images there are a number of functions that have documentation, but this is non-doxygen documentation and as such not seen by doxygen

Based on CGAL#3713 a  number of problems were solved, but also some new issues introduced.
- BaseDoxyfile.h see to it that the CGALAdvancedBegin is in a detailed part, so be sure to terminate the brief part by an extra carriage return
- commands like \pre, \note read till the beginning of the next section but a \htmlonly is not seen as a section separator, so insert an extra carriage return
- some places  missed an "Advanced" indicator, used the cgalAdvancedType here.

##Note
in Periodic_2_triangulation_2.h there appear to be a number of images that are a bit in thin air (Captions: "Insertion of a point on an edge." and "Insertion in a face."). Also just above these images theer are a number of functions that have documentation, but this is non-doxygen documentation and as such not seen by doxygen
@albert-github
Copy link
Contributor Author

I think this would be possible, but I didn't test it.

@sloriot
Copy link
Member

sloriot commented Mar 15, 2019

Shall I make the change so that you can test it?

@albert-github
Copy link
Contributor Author

I can update the pull request, so I can directly test it.

Based on suggestion of @sloriot using `^^` also in cgalAdvancedEnd instead of adding a new line in the files
@albert-github
Copy link
Contributor Author

Added new commit based on suggestion by @sloriot.

@lrineau lrineau added the Not yet approved The feature or pull-request has not yet been approved. label Mar 18, 2019
@maxGimeno
Copy link
Contributor

@lrineau lrineau added rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' and removed Ready to be tested labels Mar 19, 2019
@lrineau lrineau merged commit 28fdb2d into CGAL:master Mar 19, 2019
lrineau added a commit that referenced this pull request Mar 19, 2019
Correction of (X)HTML warnings in case of Advanced topics
@lrineau lrineau removed Not yet approved The feature or pull-request has not yet been approved. rm only: ready for release branch For the release team only: that indicates that a PR is about to be merged in a release branch Under Testing labels Mar 19, 2019
@lrineau lrineau self-assigned this Mar 19, 2019
@lrineau lrineau added this to the 4.14 milestone Mar 19, 2019
@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 Mar 19, 2019
@sloriot sloriot deleted the feature/bug_advanced_2 branch October 14, 2024 07:59
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.

5 participants