Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
sloriot committed Nov 6, 2024
1 parent b881824 commit 1b318bb
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class FrechetDistanceTraits {
/// @{

/*!
Dimension type. Either `CGAL::Dimension_tag`
Dimension type, being either `CGAL::Dimension_tag`
or `CGAL::Dynamic_dimension_tag`.
*/
typedef unspecified_type Dimension;
Expand All @@ -39,26 +39,24 @@ typedef unspecified_type FT;

/*!
A random access iterator type to enumerate the
%Cartesian coordinates of a point.
%Cartesian coordinates of a point, with `FT` as value type.
*/
typedef unspecified_type Cartesian_const_iterator_d;

/*!
Functor with operators to construct iterators on the
first and the past-the-end iterator for the %Cartesian coordinates of a point. This functor must
provide the type `result_type` that must be the same a `Cartesian_const_iterator_d`.
Functor model of `Kernel_d::ConstructCartesianConstIterator_d` to get
iterators over cartesian coordinates of a point.
*/
typedef unspecified_type Construct_cartesian_const_iterator_d;

/*!
Functor with operator to construct the bounding box of an object of type `Point_d`.
Its result_type is either `Bbox_2`, `Bbox_3` or `Bbox` depending on `Dimension`.
Functor with operator to construct the bounding box of an object of type `Point_d`,
result type is either `Bbox_2`, `Bbox_3` or `Bbox` depending on `Dimension`.
*/
typedef unspecified_type Construct_bbox_d;

/*!
Functor with operator taking two `Point_d` objects and returning the squared distance between then.
Its result_type is either `FT`.
Functor model of `Kernel_d::Squared_distance_d` to compute the squared distance between two points.
*/
typedef unspecified_type Compute_squared_distance_d;

Expand All @@ -70,7 +68,7 @@ typedef unspecified_type Compute_squared_distance_d;
/*!
Function used to construct an object of type `Construct_cartesian_const_iterator_d`.
*/
Construct_cartesian_const_iterator_d construct_construct_cartesian_const_iterator_d_object(const Point_d& p) const;
Construct_cartesian_const_iterator_d construct_cartesian_const_iterator_d_object() const;

/*!
Function used to construct an object of type `Construct_bbox_d`.
Expand Down
1 change: 1 addition & 0 deletions Frechet_distance/doc/Frechet_distance/dependencies
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Manual
Kernel_23
Kernel_d
STL_Extension
Algebraic_foundations
Circulator
Expand Down

0 comments on commit 1b318bb

Please sign in to comment.