From c55edba1a05afeee75979c310ed6d50b657f45f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Mon, 27 Jun 2022 10:14:55 +0200 Subject: [PATCH] fix doc issues --- .../CGAL/Shape_detection/Region_growing/Point_set.h | 2 +- .../Point_set/Least_squares_circle_fit_region.h | 8 ++++---- .../Point_set/Least_squares_cylinder_fit_region.h | 8 ++++---- .../Point_set/Least_squares_line_fit_region.h | 4 ++-- .../Point_set/Least_squares_sphere_fit_region.h | 10 +++++----- .../CGAL/Shape_detection/Region_growing/Polyline.h | 2 +- .../Polyline/Least_squares_line_fit_region.h | 3 --- .../CGAL/Shape_detection/Region_growing/Segment_set.h | 2 +- .../Triangle_mesh/Least_squares_plane_fit_sorting.h | 2 +- .../Triangle_mesh/One_ring_neighbor_query.h | 2 +- 10 files changed, 20 insertions(+), 23 deletions(-) diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set.h index 0fdff80e387..5d7f56838de 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set.h @@ -20,7 +20,7 @@ /** * \ingroup PkgShapeDetectionRef -* \file CGAL/Shape_detection/Region_growing/Region_growing_on_point_set.h +* \file CGAL/Shape_detection/Region_growing/Point_set.h * A convenience header that includes all classes related to the region growing algorithm on a point set. */ diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_circle_fit_region.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_circle_fit_region.h index 58ea98ebfe0..833db8dc1fa 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_circle_fit_region.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_circle_fit_region.h @@ -254,11 +254,11 @@ namespace Point_set { its normal and the circle radius is within the `maximum_angle`. If both conditions are satisfied, it returns `true`, otherwise `false`. - \param query_index - index of the query point + \param query + item of the query point - \param indices - indices of the inliers of the region + \param region + inlier items of the region The first parameter is not used in this implementation. diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_cylinder_fit_region.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_cylinder_fit_region.h index 9f3c32af185..f232a5263f9 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_cylinder_fit_region.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_cylinder_fit_region.h @@ -255,11 +255,11 @@ namespace Point_set { its normal and the cylinder radius is within the `maximum_angle`. If both conditions are satisfied, it returns `true`, otherwise `false`. - \param query_index - index of the query point + \param query + item of the query point - \param indices - indices of the inliers of the region + \param region + inlier items of the region The first parameter is not used in this implementation. diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_line_fit_region.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_line_fit_region.h index 8fe59c3aaf3..b97153fec57 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_line_fit_region.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_line_fit_region.h @@ -229,8 +229,8 @@ namespace Point_set { its normal and the line's normal is within the `maximum_angle`. If both conditions are satisfied, it returns `true`, otherwise `false`. - \param query_index - index of the query point + \param query + item of the query point The first and third parameters are not used in this implementation. diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_sphere_fit_region.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_sphere_fit_region.h index e8d2ad527fe..2d5c18e5249 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_sphere_fit_region.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Point_set/Least_squares_sphere_fit_region.h @@ -39,7 +39,7 @@ namespace Point_set { \tparam GeomTraits a model of `Kernel` - +g \tparam InputRange a model of `ConstRange` whose iterator type is `RandomAccessIterator` @@ -253,11 +253,11 @@ namespace Point_set { its normal and the sphere radius is within the `maximum_angle`. If both conditions are satisfied, it returns `true`, otherwise `false`. - \param query_index - index of the query point + \param query + item of the query point - \param indices - indices of the inliers of the region + \param region + inlier items of the region The first parameter is not used in this implementation. diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Polyline.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Polyline.h index 1802369112a..47a90aaa818 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Polyline.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Polyline.h @@ -20,7 +20,7 @@ /** * \ingroup PkgShapeDetectionRef -* \file CGAL/Shape_detection/Region_growing/Region_growing_on_polyline.h +* \file CGAL/Shape_detection/Region_growing/Polyline.h * A convenience header that includes all classes related to the region growing algorithm on a polyline. */ diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Polyline/Least_squares_line_fit_region.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Polyline/Least_squares_line_fit_region.h index 521a02f5922..89604fc42e5 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Polyline/Least_squares_line_fit_region.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Polyline/Least_squares_line_fit_region.h @@ -232,9 +232,6 @@ namespace Polyline { \param query `Item` of the query vertex - \param region - Vertices of the region represented as `Items`. - \return Boolean `true` or `false` \pre `region.size() > 0` diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Segment_set.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Segment_set.h index 1324b2b1b92..b2f1d2a8176 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Segment_set.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Segment_set.h @@ -20,7 +20,7 @@ /** * \ingroup PkgShapeDetectionRef -* \file CGAL/Shape_detection/Region_growing/Region_growing_on_segment_set.h +* \file CGAL/Shape_detection/Region_growing/Segment_set.h * A convenience header that includes all classes related to the region growing algorithm on a segment set. */ diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Triangle_mesh/Least_squares_plane_fit_sorting.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Triangle_mesh/Least_squares_plane_fit_sorting.h index d7ac6377d43..2352c61e370 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Triangle_mesh/Least_squares_plane_fit_sorting.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Triangle_mesh/Least_squares_plane_fit_sorting.h @@ -98,7 +98,7 @@ namespace Triangle_mesh { \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" - \param pmesh + \param tmesh an instance of `TriangleMesh` that represents a triangle mesh \param neighbor_query diff --git a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Triangle_mesh/One_ring_neighbor_query.h b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Triangle_mesh/One_ring_neighbor_query.h index a91a0a05497..39255bb9215 100644 --- a/Shape_detection/include/CGAL/Shape_detection/Region_growing/Triangle_mesh/One_ring_neighbor_query.h +++ b/Shape_detection/include/CGAL/Shape_detection/Region_growing/Triangle_mesh/One_ring_neighbor_query.h @@ -64,7 +64,7 @@ namespace Triangle_mesh { /*! \brief initializes all internal data structures. - \param pmesh + \param tmesh an instance of a `TriangleMesh` that represents a triangle mesh \pre `faces(pmesh).size() > 0`