From 9ec7f209f812eb9e4fb189e232fffdce7264014c Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Wed, 27 Apr 2022 10:51:55 +0100 Subject: [PATCH] Clean up: backticks, dependencies, add () to functions etc --- .../Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h | 2 +- .../CGAL/Min_quadrilateral_traits_2.h | 2 +- .../doc/Bounding_volumes/Concepts/Circle.h | 14 +++++++------- Bounding_volumes/doc/Bounding_volumes/dependencies | 2 ++ 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h index 84b17a0925f..25b54759c1a 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h @@ -5,7 +5,7 @@ namespace CGAL { \ingroup PkgBoundingVolumesRef The class `Min_ellipse_2_traits_2` is a traits class for `CGAL::Min_ellipse_2` -using the two-di-men-sional \cgal kernel. +using the two-dimensional \cgal kernel. The template parameter `K` must be a model for `Kernel`. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h index 1165c14c61a..c1ad3dbfc22 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h @@ -5,7 +5,7 @@ namespace CGAL { \ingroup PkgBoundingVolumesRef The class `Min_quadrilateral_default_traits_2` is a traits class for the -functions `min_rectangle_2`, `min_parallelogram_2` and +functions `min_rectangle_2()`, `min_parallelogram_2()` and `min_strip_2` using a two-dimensional \cgal kernel. \tparam K must be a model for `Kernel`. diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h index 06eb9f21ee1..eb5b1e89157 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h @@ -2,11 +2,11 @@ \ingroup PkgBoundingVolumesConcepts \cgalConcept -An object of the class `Circle` is a circle in two-dimensional +An object `circle` of the class `Circle` is a circle in the two-dimensional Euclidean plane \f$ \E^2\f$. Its boundary splits the plane into a bounded -and an unbounded side. By definition, an empty `Circle` has no +and an unbounded side. By definition, an empty `circle` has no boundary and no bounded side, i.e.\ its unbounded side equals the -whole plane \f$ \E^2\f$. A `Circle` containing exactly one point \f$ p\f$ +whole plane \f$ \E^2\f$. A `circle` containing exactly one point \f$ p\f$ has no bounded side, its boundary is \f$ \{p\}\f$, and its unbounded side equals \f$ \E^2 \setminus \{p\}\f$. @@ -42,21 +42,21 @@ typedef unspecified_type Distance; void set(); /** - * sets `circle` to the circle containing exactly \f$ \{\mbox{`p` }\}\f$. + * sets `circle` to the circle containing exactly `p`. */ void set( const Point& p); /*! sets `circle` to the circle with diameter equal to the segment -connecting `p` and `q`. The algorithm guarantees that `set` is never +connecting `p` and `q`. The algorithm guarantees that `set()` is never called with two equal points. */ void set( const Point& p, const Point& q); /*! -sets `circle` to the circle through `p`,`q`,`r`. The algorithm -guarantees that `set` is never called with three collinear points. +sets `circle` to the circle through `p`, `q`, and `r`. The algorithm +guarantees that `set()` is never called with three collinear points. */ void set( const Point& p, const Point& q, const Point& r); diff --git a/Bounding_volumes/doc/Bounding_volumes/dependencies b/Bounding_volumes/doc/Bounding_volumes/dependencies index a4d5f76715e..0f2411a6c67 100644 --- a/Bounding_volumes/doc/Bounding_volumes/dependencies +++ b/Bounding_volumes/doc/Bounding_volumes/dependencies @@ -4,3 +4,5 @@ STL_Extension Algebraic_foundations Circulator Stream_support +Matrix_search +Polytope_distance_d