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

Minor doc fixes

This commit is contained in:
Mael Rouxel-Labbé 2017-04-10 18:48:37 +02:00
parent 8703f5c122
commit cc4f17c9e7
4 changed files with 20 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Kernel_23/doc/Kernel_23/CGAL/Point_2.h
View File

@ -8,10 +8,9 @@ Euclidean plane \f$ \E^2\f$.
Remember that `Kernel::RT` and `Kernel::FT` denote a Remember that `Kernel::RT` and `Kernel::FT` denote a
`RingNumberType` and a `FieldNumberType`, respectively. For the kernel `RingNumberType` and a `FieldNumberType`, respectively. For the kernel
model `Cartesian<T>`, the two types are the same. For the model `Cartesian<NT>`, the two types are the same. For the
kernel model `Homogeneous<T>`, `Kernel::RT` is equal kernel model `Homogeneous<NT>`, `Kernel::RT` is equal
to `T`, and `Kernel::FT` is equal to to `NT`, and `Kernel::FT` is equal to `Quotient<NT>`.
`Quotient<T>`.
\cgalHeading{Operators} \cgalHeading{Operators}
@ -166,14 +165,14 @@ Kernel::RT homogeneous(int i) const;
/*! /*!
returns the i'th %Cartesian coordinate of `p`, starting with 0. returns the i'th %Cartesian coordinate of `p`, starting with 0.
\pre \f$ 0\leq i \leq1\f$. \pre \f$ 0\leq i \leq1\f$.
*/ */
Kernel::FT cartesian(int i) const; Kernel::FT cartesian(int i) const;
/*! /*!
returns `cartesian(i)`. returns `cartesian(i)`.
\pre \f$ 0\leq i \leq1\f$. \pre \f$ 0\leq i \leq1\f$.
*/ */
Kernel::FT operator[](int i) const; Kernel::FT operator[](int i) const;
/*! /*!

11
Kernel_23/doc/Kernel_23/CGAL/Point_3.h
View File

@ -6,12 +6,11 @@ namespace CGAL {
An object of the class `Point_3` is a point in the three-dimensional An object of the class `Point_3` is a point in the three-dimensional
Euclidean space \f$ \E^3\f$. Euclidean space \f$ \E^3\f$.
Remember that `Kernel::RT` and `Kernel::FT` denote a Remember that `Kernel::RT` and `Kernel::FT` denote a
RingNumberType and a FieldNumberType, respectively. For the kernel `RingNumberType` and a `FieldNumberType`, respectively. For the kernel
model `Cartesian<T>`, the two types are the same. For the model `Cartesian<NT>`, the two types are the same. For the
kernel model `Homogeneous<T>`, `Kernel::RT` is equal kernel model `Homogeneous<NT>`, `Kernel::RT` is equal
to `T`, and `Kernel::FT` is equal to to `NT`, and `Kernel::FT` is equal to `Quotient<NT>`.
`Quotient<T>`.
\cgalHeading{Operators} \cgalHeading{Operators}

7
Kernel_23/doc/Kernel_23/CGAL/Weighted_point_2.h
View File

@ -7,10 +7,9 @@ An object of the class `Weighted_point_2` is a tuple of a two-dimensional point
Remember that `Kernel::RT` and `Kernel::FT` denote a Remember that `Kernel::RT` and `Kernel::FT` denote a
`RingNumberType` and a `FieldNumberType`, respectively. For the kernel `RingNumberType` and a `FieldNumberType`, respectively. For the kernel
model `Cartesian<T>`, the two types are the same. For the model `Cartesian<NT>`, the two types are the same. For the
kernel model `Homogeneous<T>`, `Kernel::RT` is equal kernel model `Homogeneous<NT>`, `Kernel::RT` is equal
to `T`, and `Kernel::FT` is equal to to `NT`, and `Kernel::FT` is equal to `Quotient<NT>`.
`Quotient<T>`.
\sa `Point_2<Kernel>` \sa `Point_2<Kernel>`

13
Kernel_23/doc/Kernel_23/CGAL/Weighted_point_3.h
View File

@ -7,10 +7,9 @@ An object of the class `Weighted_point_3` is a tuple of a three-dimensional poin
Remember that `Kernel::RT` and `Kernel::FT` denote a Remember that `Kernel::RT` and `Kernel::FT` denote a
`RingNumberType` and a `FieldNumberType`, respectively. For the kernel `RingNumberType` and a `FieldNumberType`, respectively. For the kernel
model `Cartesian<T>`, the two types are the same. For the model `Cartesian<NT>`, the two types are the same. For the
kernel model `Homogeneous<T>`, `Kernel::RT` is equal kernel model `Homogeneous<NT>`, `Kernel::RT` is equal
to `T`, and `Kernel::FT` is equal to to `NT`, and `Kernel::FT` is equal to `Quotient<NT>`.
`Quotient<T>`.
\sa `Point_3<Kernel>` \sa `Point_3<Kernel>`
@ -92,7 +91,7 @@ public:
/// @{ /// @{
/*! /*!
Test for equality. Two points are equal, iff their \f$ x\f$ and \f$ y\f$ Test for equality. Two points are equal, iff their \f$ x\f$, \f$ y\f$, and \f$ z\f$
coordinates are equal. The point can be compared with `ORIGIN`. coordinates are equal. The point can be compared with `ORIGIN`.
*/ */
bool operator==(const Weighted_point_3<Kernel> &q) const; bool operator==(const Weighted_point_3<Kernel> &q) const;
@ -173,13 +172,13 @@ public:
/*! /*!
returns the i'th %Cartesian coordinate of `p`, starting with 0. returns the i'th %Cartesian coordinate of `p`, starting with 0.
\pre \f$ 0\leq i \leq1\f$. \pre \f$ 0\leq i \leq2\f$.
*/ */
Kernel::FT cartesian(int i) const; Kernel::FT cartesian(int i) const;
/*! /*!
returns `cartesian(i)`. returns `cartesian(i)`.
\pre \f$ 0\leq i \leq1\f$. \pre \f$ 0\leq i \leq2\f$.
*/ */
Kernel::FT operator[](int i) const; Kernel::FT operator[](int i) const;