From 00d289baee11bbc438fddfd7542d6a6dc4eeaeb8 Mon Sep 17 00:00:00 2001 From: Jane Tournois Date: Mon, 29 Jun 2015 14:10:58 +0200 Subject: [PATCH] add doc about property maps to the reference manual --- .../Polygon_mesh_processing/connected_components.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) 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 d8fc99f76dc..90f6ea1fdf8 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 @@ -476,6 +476,10 @@ connected_component(typename boost::graph_traits::face_descriptor s * \ingroup PkgPolygonMeshProcessing * computes for each face the index of the corresponding connected component. * Two faces are recorded in the same connected component if they share an edge that is not marked as constrained. + * + * A property map for `CGAL::face_index_t` should be either available as an internal property map + * to `pmesh` or provided as one of the \ref namedparameters. + * * \tparam PolygonMesh a model of `FaceListGraph` * \tparam FaceComponentMap a model of `WritablePropertyMap` with `boost::graph_traits::%face_descriptor` as key type and @@ -549,6 +553,10 @@ connected_components(const PolygonMesh& pmesh, * Keep `nb_components_to_keep` largest connected components. * Two faces are considered in the same connected component if they share an edge that is not marked as constrained. * + * Property maps for `CGAL::face_index_t` and `CGAL::vertex_index_t` + * should be either available as internal property maps + * to `pmesh` or provided as \ref namedparameters. + * * \tparam PolygonMesh a model of `FaceListGraph` * \tparam NamedParameters a sequence of \ref namedparameters * @@ -752,6 +760,11 @@ std::size_t keep_largest_connected_components(PolygonMesh& pmesh, * and erases the other connected components and all the isolated vertices. * Two faces are considered in the same connected component if they share an edge that is not marked as constrained. * +* Property maps for `CGAL::face_index_t` and `CGAL::vertex_index_t` +* should be either available as internal property maps +* to `pmesh` or provided as \ref namedparameters. +* +* * \tparam PolygonMesh a model of `FaceListGraph` * \tparam NamedParameters a sequence of \ref namedparameters * \tparam FaceRange a range of `boost::graph_traits::%face_descriptor`