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

Aos 2 traits concept efif #8713

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

efifogel
Copy link
Member

@efifogel efifogel commented Jan 23, 2025

Summary of Changes

This PR does not change the code (except perhaps some negligible changes, such as adding or removing spaces or editing comments).

  1. Renamed the prefix of the names of all concepts in the Arrangement_on_surface_2 package from "Arrangement" to "Aos". This slightly affects packages other than the Aos_2 package.
  2. Introduced a new concept called AosApproximateTraits_2. It refines the concept AosApproximatePointTraits_2. This concept requires the provision of a functor called Approximate_2. In addition to an operator that approximates the coordinates of a point, it also requires the provision of (i) an operator that approximates a points, and (ii) an operator that approximates a curve.
  3. Changed all "typedef" style statements in the user manual to "using" style. (Observe that a similar update to the examples has already been made in a previous release.)

Release Management

@MaelRL MaelRL added Not yet approved The feature or pull-request has not yet been approved. Small feature Pkg::Arrangement_on_surface_2 labels Feb 20, 2025
@MaelRL MaelRL added this to the 6.1-beta milestone Feb 20, 2025
@@ -0,0 +1,77 @@
/*! \ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept
Copy link
Contributor

@albert-github albert-github Feb 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the \cgalConcept is intended here, as this is an ALIASES with content:

cgalConcept=\details <div id=\"CGALConcept\"></div>^^ \brief"

resulting in:

/home/cgal-testsuite/cgal_doc_build/CGAL-6.1-Ic-96/doc/Arrangement_on_surface_2/Concepts/AosTraits_2.h:51: warning: Found non-existing group 'details' for the command '@ingroup', ignoring command
/home/cgal-testsuite/cgal_doc_build/CGAL-6.1-Ic-96/doc/Arrangement_on_surface_2/Concepts/AosTraits_2.h:51: warning: Found non-existing group 'div' for the command '@ingroup', ignoring command
/home/cgal-testsuite/cgal_doc_build/CGAL-6.1-Ic-96/doc/Arrangement_on_surface_2/Concepts/AosTraits_2.h:51: warning: Found non-existing group 'id' for the command '@ingroup', ignoring command
/home/cgal-testsuite/cgal_doc_build/CGAL-6.1-Ic-96/doc/Arrangement_on_surface_2/Concepts/AosTraits_2.h:51: warning: Found non-existing group 'CGALConcept' for the command '@ingroup', ignoring command
/home/cgal-testsuite/cgal_doc_build/CGAL-6.1-Ic-96/doc/Arrangement_on_surface_2/Concepts/AosTraits_2.h:51: warning: Found non-existing group 'div' for the command '@ingroup', ignoring command

during the overnight doxygen build https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/CGAL-6.1-Ic-96/logs_master/Arrangement_on_surface_2.log

Either the \cgalConcept:

  • should be removed here
  • should be on a separate line.

@efifogel
Copy link
Member Author

efifogel commented Feb 25, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants