From ad8ebeaa015ab05fb79af3cf03a1b8b8703e28bb Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Wed, 19 Sep 2018 14:12:40 +0200 Subject: [PATCH] Fix documentation of named parameters, replacing iterators by value_type --- .../Point_set_processing_3/NamedParameters.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Point_set_processing_3/doc/Point_set_processing_3/NamedParameters.txt b/Point_set_processing_3/doc/Point_set_processing_3/NamedParameters.txt index 9d6702cdd6a..ee321dfd95e 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/NamedParameters.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/NamedParameters.txt @@ -31,17 +31,17 @@ typename CGAL::Kernel_traits::Kernel \cgalNPEnd \cgalNPBegin{point_map} \anchor PSP_point_map - is the property map containing the points associated to the iterators of the point range `points`.\n + is the property map containing the points associated to the elements of the point range `points`.\n \b Type: a class model of `ReadablePropertyMap` with -`PointRange::iterator` as key type and +`PointRange::iterator::value_type` as key type and `geom_traits::Point_3` as value type. \n Default value: \code CGAL::Identity_property_map\endcode \cgalNPEnd \cgalNPBegin{normal_map} \anchor PSP_normal_map - is the property map containing the normal vectors associated to the iterators of the point range `points`.\n + is the property map containing the normal vectors associated to the elements of the point range `points`.\n \b Type: a class model of `ReadablePropertyMap` with -`PointRange::iterator` as key type and +`PointRange::iterator::value_type` as key type and `geom_traits::Vector_3` as value type. \n No default value. \cgalNPEnd @@ -67,9 +67,9 @@ Note that when a callback is run on a parallelized algorithm with `CGAL::Paralle \cgalNPEnd \cgalNPBegin{query_point_map} \anchor PSP_query_point_map - is the property map containing the points associated to the iterators of the point range `queries`.\n + is the property map containing the points associated to the elements of the point range `queries`.\n \b Type: a class model of `ReadablePropertyMap` with -`PointRange::iterator` as key type and +`PointRange::iterator::value_type` as key type and `geom_traits::Point_3` as value type. \n Default value: \code CGAL::Identity_property_map\endcode \cgalNPEnd @@ -146,9 +146,9 @@ multiple of a tolerance `epsilon` used to connect simplices. \cgalNPEnd \cgalNPBegin{plane_map} \anchor PSP_plane_map - is the property map containing the planes associated to the iterators of the plane range `planes`.\n + is the property map containing the planes associated to the elements of the plane range `planes`.\n \b Type: a class model of `ReadablePropertyMap` with -`PlaneRange::iterator` as key type and +`PlaneRange::iterator::value_type` as key type and `geom_traits::Plane_3` as value type. \n Default value: \code CGAL::Identity_property_map\endcode \cgalNPEnd