Apply suggestions from code review

Co-authored-by: Mael <mael.rouxel.labbe@geometryfactory.com>
sloriot · Apr 10, 2024 · f498daa · f498daa
1 parent ed05a4e
commit f498daa
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits_3.h b/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits_3.h
@@ -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`
 

diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionTraits.h
@@ -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 @@ class AABBRayIntersectionTraits {
  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;

diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h
@@ -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}

diff --git a/AABB_tree/include/CGAL/AABB_indexed_triangle_primitive_2.h b/AABB_tree/include/CGAL/AABB_indexed_triangle_primitive_2.h
@@ -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.