songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review 

Co-authored-by: Mael <mael.rouxel.labbe@geometryfactory.com>
This commit is contained in:
Andreas Fabri 2024-04-10 12:11:19 +02:00 committed by GitHub
parent ed05a4e64b
commit f498daad1e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits_3.h
View File

@ -13,7 +13,7 @@ define the Intersection_distance functor.
\cgalHasModelsBare{All models of the concept `Kernel`}
\cgalHasModelsEnd
\sa `CGAL::AABB_traits_3<AABBGeomTraits,AABBPrimitive>`
\sa `CGAL::AABB_traits_3<AABBGeomTraits_3,AABBPrimitive>`
\sa `CGAL::AABB_tree<AABBTraits>`
\sa `AABBPrimitive`

6
AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionTraits.h
View File

@ -8,8 +8,8 @@ The concept `AABBRayIntersectionTraits` is a refinement of the concept
distance of an intersection along a ray.
\cgalHasModelsBegin
\cgalHasModels{CGAL::AABB_traits_2<AABBGeomTraits,AABBPrimitive>}
\cgalHasModels{CGAL::AABB_traits_3<AABBGeomTraits,AABBPrimitive>}
\cgalHasModels{CGAL::AABB_traits_2<AABBGeomTraits_2,AABBPrimitive>}
\cgalHasModels{CGAL::AABB_traits_3<AABBGeomTraits_3,AABBPrimitive>}
\cgalHasModelsEnd
\sa `CGAL::AABB_tree<AABBTraits>`
@ -53,7 +53,7 @@ public:
Construct_source construct_cartesian_const_iterator_object();
/*!
A functor object to construct a vector giving the direction of a ray. Provides the operator:
A functor object to construct a vector having the same direction as a ray. Provides the operator:
`Vector operator()(const Ray&);`
*/
typedef unspecified_type Construct_vector;

4
AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h
View File

@ -6,8 +6,8 @@
The concept `AABBTraits` provides the geometric primitive types and methods for the class `CGAL::AABB_tree<AABBTraits>`.
\cgalHasModelsBegin
\cgalHasModels{CGAL::AABB_traits_2<AABBGeomTraits,AABBPrimitive>}
\cgalHasModels{CGAL::AABB_traits_3<AABBGeomTraits,AABBPrimitive>}
\cgalHasModels{CGAL::AABB_traits_2<AABBGeomTraits_2,AABBPrimitive>}
\cgalHasModels{CGAL::AABB_traits_3<AABBGeomTraits_3,AABBPrimitive>}
\cgalHasModelsEnd
\cgalRefines{SearchTraits}

4
AABB_tree/include/CGAL/AABB_indexed_triangle_primitive_2.h
View File

@ -73,14 +73,14 @@ namespace internal {
/*!
* \ingroup PkgAABBTreeRef
* Primitive type that uses as identifier an iterator with a range of 3 indices as `value_type`.
* Primitive type that uses as identifier an iterator with a range of three indices as `value_type`.
* The iterator from which the primitive is built should not be invalided
* while the AABB tree holding the primitive is in use.
*
* \cgalModels{AABBPrimitive}
*
* \tparam GeomTraits is a traits class providing the nested type `Point_2` and `Triangle_2`.
* It also provides the functor `Construct_triangle_2` that has an operator taking 3 `Point_2` as
* It also provides the functor `Construct_triangle_2` that has an operator taking three `Point_2` as
* parameters and returns a `Triangle_2`
* \tparam IndexIterator is a model of `ForwardIterator` with its value type being a `RandomAccessRange` of size 3 with an index type as `value_type`, e.g., `uint8_t`, `uint16_t` or int.
* \tparam PointRange is a model of `RandomAccessRange`. Its value type needs to be compatible to PointMap or `Point_2` in the default case.