diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/clip.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/clip.h index 2fc1347a98e..3001e1c0c3f 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/clip.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/clip.h @@ -616,20 +616,34 @@ bool clip(TriangleMesh& tm, * @param np optional sequence of \ref pmp_namedparameters "Named Parameters" among the ones listed below * * \cgalNamedParamsBegin - * \cgalParamBegin{visitor} a class model of `PMPCorefinementVisitor` - * that is used to track the creation of new faces. - * \cgalParamEnd - * \cgalParamBegin{throw_on_self_intersection} if `true`, - * the set of triangles closed to the intersection of `tm` and `iso_cuboid` will be - * checked for self-intersections and `CGAL::Polygon_mesh_processing::Corefinement::Self_intersection_exception` - * will be thrown if at least one is found. - * \cgalParamEnd - * \cgalParamBegin{clip_volume} if `true` and `tm` is closed, the clipping will be done on - * the volume \link coref_def_subsec bounded \endlink by `tm` rather than on its surface - * (i.e., `tm` will be kept closed). - * \cgalParamEnd - * \cgalParamBegin{use_compact_clipper} if `false` and `clip_volume` is `false` and `tm` is open, the parts of `tm` coplanar with `is_cuboid` - * will not be part of the output. + * \cgalParamNBegin{visitor} + * \cgalParamDescription{a visitor used to track the creation of new faces} + * \cgalParamType{a class model of `PMPCorefinementVisitor`} + * \cgalParamDefault{`Corefinement::Default_visitor`} + * \cgalParamNEnd + * + * \cgalParamNBegin{throw_on_self_intersection} + * \cgalParamDescription{If `true`, the set of triangles closed to the intersection of `tm` + * and `iso_cuboid` will be checked for self-intersections + * and `CGAL::Polygon_mesh_processing::Corefinement::Self_intersection_exception` + * will be thrown if at least one self-intersection is found.} + * \cgalParamType{Boolean} + * \cgalParamDefault{`false`} + * \cgalParamNEnd + * + * \cgalParamNBegin{clip_volume} + * \cgalParamDescription{If `true`, and `tm` is closed, the clipping will be done on + * the volume \link coref_def_subsec bounded \endlink by `tm` + * rather than on its surface (i.e., `tm` will be kept closed).} + * \cgalParamType{Boolean} + * \cgalParamDefault{`false`} + * \cgalParamNEnd + * + * \cgalParamNBegin{use_compact_clipper} + * \cgalParamDescription{if `false` the parts of `tm` coplanar with `iso_cuboid` will not be part of the output} + * \cgalParamType{Boolean} + * \cgalParamDefault{`true`} + * \cgalParamNEnd * \cgalNamedParamsEnd * * @return `true` if the output surface mesh is manifold. @@ -862,7 +876,7 @@ void split(TriangleMesh& tm, * \cgalParamNEnd * * \cgalParamNBegin{use_compact_clipper} - * \cgalParamDescription{if `false` the parts of `tm` coplanar with `plane` will not be part of the output} + * \cgalParamDescription{if `false` the parts of `tm` coplanar with `iso_cuboid` will not be part of the output} * \cgalParamType{Boolean} * \cgalParamDefault{`true`} * \cgalParamNEnd diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/connected_components.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/connected_components.h index 2f29d3d77b5..769073ad527 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/connected_components.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/connected_components.h @@ -1131,11 +1131,6 @@ void split_connected_components_impl(FIMap fim, * \cgalParamNBegin{vertex_index_map} * \cgalParamDescription{a property map associating to each vertex of `pmesh` a unique index between `0` and `num_vertices(pmesh) - 1`} * \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits::%vertex_descriptor` - * \cgalParamBegin{face_patch_map} a property map with the patch id's associated to the - faces of `pm`. Instance of a class model of `ReadPropertyMap`. - If not provided, an internal map will be filled with a call to - `connected_components()` with `edge_is_constrained_map()` (if provided). -* \cgalParamEnd * as key type and `std::size_t` as value type} * \cgalParamDefault{an automatically indexed internal map} * \cgalParamNEnd @@ -1153,6 +1148,17 @@ void split_connected_components_impl(FIMap fim, * as key type and `std::size_t` as value type} * \cgalParamDefault{an automatically indexed internal map} * \cgalParamNEnd + * + * \cgalParamNBegin{face_patch_map} + * \cgalParamDescription{a property map with the patch id's associated to the faces of `pmesh`} + * \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits::%face_descriptor` + * as key type and the desired property, model of `CopyConstructible` as value type.} + * \cgalParamDefault{a default property map where each face is associated with the ID of + * the connected component it belongs to. Connected components are + * computed with respect to the constrained edges listed in the property map + * `edge_is_constrained_map`} + * \cgalParamExtra{The map is updated during the remeshing process while new faces are created.} + * \cgalParamNEnd * \cgalNamedParamsEnd * */