fix doc issues

This commit is contained in:
Sébastien Loriot 2022-06-27 10:14:55 +02:00
parent a8e4050206
commit c55edba1a0
10 changed files with 20 additions and 23 deletions

View File

@ -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.
*/

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.
*/

View File

@ -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`

View File

@ -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.
*/

View File

@ -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

View File

@ -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`