From cc4f17c9e7f0b2cb5465f67ee780d145805b1899 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 10 Apr 2017 18:48:37 +0200 Subject: [PATCH] Minor doc fixes --- Kernel_23/doc/Kernel_23/CGAL/Point_2.h | 13 ++++++------- Kernel_23/doc/Kernel_23/CGAL/Point_3.h | 11 +++++------ Kernel_23/doc/Kernel_23/CGAL/Weighted_point_2.h | 7 +++---- Kernel_23/doc/Kernel_23/CGAL/Weighted_point_3.h | 13 ++++++------- 4 files changed, 20 insertions(+), 24 deletions(-) diff --git a/Kernel_23/doc/Kernel_23/CGAL/Point_2.h b/Kernel_23/doc/Kernel_23/CGAL/Point_2.h index 76164f40016..effc841ce7d 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Point_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Point_2.h @@ -8,10 +8,9 @@ Euclidean plane \f$ \E^2\f$. Remember that `Kernel::RT` and `Kernel::FT` denote a `RingNumberType` and a `FieldNumberType`, respectively. For the kernel -model `Cartesian`, the two types are the same. For the -kernel model `Homogeneous`, `Kernel::RT` is equal -to `T`, and `Kernel::FT` is equal to -`Quotient`. +model `Cartesian`, the two types are the same. For the +kernel model `Homogeneous`, `Kernel::RT` is equal +to `NT`, and `Kernel::FT` is equal to `Quotient`. \cgalHeading{Operators} @@ -166,14 +165,14 @@ Kernel::RT homogeneous(int i) const; /*! 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; /*! returns `cartesian(i)`. -\pre \f$ 0\leq i \leq1\f$. -*/ +\pre \f$ 0\leq i \leq1\f$. +*/ Kernel::FT operator[](int i) const; /*! diff --git a/Kernel_23/doc/Kernel_23/CGAL/Point_3.h b/Kernel_23/doc/Kernel_23/CGAL/Point_3.h index 82efc70fe34..f66dab91404 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Point_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Point_3.h @@ -6,12 +6,11 @@ namespace CGAL { An object of the class `Point_3` is a point in the three-dimensional Euclidean space \f$ \E^3\f$. -Remember that `Kernel::RT` and `Kernel::FT` denote a -RingNumberType and a FieldNumberType, respectively. For the kernel -model `Cartesian`, the two types are the same. For the -kernel model `Homogeneous`, `Kernel::RT` is equal -to `T`, and `Kernel::FT` is equal to -`Quotient`. +Remember that `Kernel::RT` and `Kernel::FT` denote a +`RingNumberType` and a `FieldNumberType`, respectively. For the kernel +model `Cartesian`, the two types are the same. For the +kernel model `Homogeneous`, `Kernel::RT` is equal +to `NT`, and `Kernel::FT` is equal to `Quotient`. \cgalHeading{Operators} diff --git a/Kernel_23/doc/Kernel_23/CGAL/Weighted_point_2.h b/Kernel_23/doc/Kernel_23/CGAL/Weighted_point_2.h index 46b22b1702b..8a4c9d1f3d0 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Weighted_point_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Weighted_point_2.h @@ -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 `RingNumberType` and a `FieldNumberType`, respectively. For the kernel -model `Cartesian`, the two types are the same. For the -kernel model `Homogeneous`, `Kernel::RT` is equal -to `T`, and `Kernel::FT` is equal to -`Quotient`. +model `Cartesian`, the two types are the same. For the +kernel model `Homogeneous`, `Kernel::RT` is equal +to `NT`, and `Kernel::FT` is equal to `Quotient`. \sa `Point_2` diff --git a/Kernel_23/doc/Kernel_23/CGAL/Weighted_point_3.h b/Kernel_23/doc/Kernel_23/CGAL/Weighted_point_3.h index f79c61399bb..4f89298552f 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Weighted_point_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Weighted_point_3.h @@ -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 `RingNumberType` and a `FieldNumberType`, respectively. For the kernel -model `Cartesian`, the two types are the same. For the -kernel model `Homogeneous`, `Kernel::RT` is equal -to `T`, and `Kernel::FT` is equal to -`Quotient`. +model `Cartesian`, the two types are the same. For the +kernel model `Homogeneous`, `Kernel::RT` is equal +to `NT`, and `Kernel::FT` is equal to `Quotient`. \sa `Point_3` @@ -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`. */ bool operator==(const Weighted_point_3 &q) const; @@ -173,13 +172,13 @@ public: /*! 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; /*! returns `cartesian(i)`. - \pre \f$ 0\leq i \leq1\f$. + \pre \f$ 0\leq i \leq2\f$. */ Kernel::FT operator[](int i) const;