documentation of check_preconditions, the new NP

This commit is contained in:
Jane Tournois 2025-05-12 15:38:34 +02:00
parent 270c507ce7
commit ebd9ecab58
2 changed files with 21 additions and 0 deletions

View File

@ -114,6 +114,15 @@ namespace CGAL {
* Faces with the same patch identifier are considered part of the same surface patch.}
* \cgalParamNEnd
*
* \cgalParamNBegin{check_preconditions}
* \cgalParamDescription{a boolean activating the check of preconditions on the input
* before starting to construct the triangulation.
* If the check is activated and the preconditions not satisfied,
* the constructed triangulation is empty.}
* \cgalParamType{Boolean}
* \cgalParamDefault{`false`}
* \cgalParamNEnd
*
* \cgalParamNBegin{geom_traits}
* \cgalParamDescription{an instance of a geometric traits class}
* \cgalParamType{`Traits` as defined above in the section \ref make_conforming_constrained_Delaunay_triangulation_3_returned_type}
@ -177,6 +186,15 @@ auto make_conforming_constrained_Delaunay_triangulation_3(const PolygonMesh &mes
* \cgalParamExtra{Otherwise faces with the same patch identifier are considered part of the same surface patch.}
* \cgalParamNEnd
*
* \cgalParamNBegin{check_preconditions}
* \cgalParamDescription{a boolean activating the check of preconditions on the input
* before starting to construct the triangulation.
* If the check is activated and the preconditions not satisfied,
* the constructed triangulation is empty.}
* \cgalParamType{Boolean}
* \cgalParamDefault{`false`}
* \cgalParamNEnd
*
* \cgalParamNBegin{geom_traits}
* \cgalParamDescription{an instance of a geometric traits class}
* \cgalParamType{`Traits` as defined above in the section \ref make_conforming_constrained_Delaunay_triangulation_3_returned_type}

View File

@ -321,6 +321,9 @@ CGAL_add_named_parameter(preserve_order_t, preserve_order, preserve_order)
CGAL_add_named_parameter(adjust_directions_t, adjust_directions, adjust_directions)
CGAL_add_named_parameter(segment_t, segment_map, segment_map)
// List of named parameters using in Constrained_triangulation_3
CGAL_add_named_parameter(check_preconditions_t, check_preconditions, check_preconditions)
// List of named parameters used in Mesh_2 package
CGAL_add_named_parameter_with_compatibility(seeds_t, seeds, seeds)
CGAL_add_named_parameter_with_compatibility(domain_is_initialized_t, domain_is_initialized, domain_is_initialized)