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

Clean up: backticks, dependencies, add () to functions etc

This commit is contained in:
Andreas Fabri 2022-04-27 10:51:55 +01:00
parent d14345fc25
commit 9ec7f209f8
4 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h
View File

@ -5,7 +5,7 @@ namespace CGAL {
\ingroup PkgBoundingVolumesRef
The class `Min_ellipse_2_traits_2` is a traits class for `CGAL::Min_ellipse_2<Traits>`
using the two-di-men-sional \cgal kernel.
using the two-dimensional \cgal kernel.
The template parameter `K` must be a model for `Kernel`.

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h
View File

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

14
Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h
View File

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

2
Bounding_volumes/doc/Bounding_volumes/dependencies
View File

@ -4,3 +4,5 @@ STL_Extension
Algebraic_foundations
Circulator
Stream_support
Matrix_search
Polytope_distance_d