From 0c4902a2dc987015cadfe2202e2f988f43c46d88 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Mon, 23 Mar 2015 11:03:32 +0100 Subject: [PATCH] fix documentation in Nef_2 --- .../doc/Algebraic_foundations/Concepts/FieldNumberType.h | 6 +++--- .../doc/Algebraic_foundations/Concepts/RingNumberType.h | 8 ++++---- Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h | 6 +----- Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h | 9 +-------- Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h | 2 ++ Number_types/doc/Number_types/CGAL/leda_rational.h | 2 +- 6 files changed, 12 insertions(+), 21 deletions(-) diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h index e53d91eb9b6..9a58da5493e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h @@ -17,9 +17,9 @@ for Cartesian kernels. \cgalHasModel \ref CGAL::Interval_nt_advanced \cgalHasModel `CGAL::Lazy_exact_nt` \cgalHasModel `CGAL::Quotient` -\cgalHasModel `CGAL::leda_rational` -\cgalHasModel `CGAL::leda_bigfloat` -\cgalHasModel `CGAL::leda_real` +\cgalHasModel `leda_rational` +\cgalHasModel `leda_bigfloat` +\cgalHasModel `leda_real` \sa `RingNumberType` \sa `Kernel` diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h index bc322881dad..e04320687ba 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h @@ -20,10 +20,10 @@ for Homogeneous kernels. \cgalHasModel `CGAL::MP_Float` \cgalHasModel `CGAL::Gmpzf` \cgalHasModel `CGAL::Quotient` -\cgalHasModel `CGAL::leda_integer` -\cgalHasModel `CGAL::leda_rational` -\cgalHasModel `CGAL::leda_bigfloat` -\cgalHasModel `CGAL::leda_real` +\cgalHasModel `leda_integer` +\cgalHasModel `leda_rational` +\cgalHasModel `leda_bigfloat` +\cgalHasModel `leda_real` \sa `FieldNumberType` diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h index bb18b82facb..ecb679d14c4 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h @@ -10,11 +10,7 @@ representation based on a field number type `FT`. \cgalModels `ExtendedKernelTraits_2` -\cgalHeading{Requirements} - -To make a field number type `FT_model` work with this class, you -must provide a specialization of the traits class -`Number_type_traits` +\tparam FT must be a model of `FieldNumberType`. diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h index 90388050a96..1c77cd7f52e 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h @@ -10,15 +10,8 @@ representation based on a Euclidean ring number type `RT`. \cgalModels `ExtendedKernelTraits_2` -\cgalHeading{Requirements} -To make an Euclidean ring number type -`RT_model` work with this class the number type must support -a gcd computation in namespace `CGAL::NTS`. \cgal provides -a function template for this, which will be used by default when -your number type is not one of the built-in number types, one of -the number types distrubuted with \cgal or one of the \leda -number types. +\tparam RT must be a model of `RingNumberType`. \sa `CGAL::Extended_cartesian` diff --git a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h index ae4436f92b0..f70c8ad5d12 100644 --- a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h @@ -10,6 +10,8 @@ representation based on a ring number type `RT`. \cgalModels `ExtendedKernelTraits_2` +\tparam RT must be a model of `RingNumberType`. + \sa `CGAL::Extended_cartesian` \sa `CGAL::Extended_homogeneous` diff --git a/Number_types/doc/Number_types/CGAL/leda_rational.h b/Number_types/doc/Number_types/CGAL/leda_rational.h index 113ad1e2b12..2d716267fad 100644 --- a/Number_types/doc/Number_types/CGAL/leda_rational.h +++ b/Number_types/doc/Number_types/CGAL/leda_rational.h @@ -2,7 +2,7 @@ /*! \ingroup nt_leda -The class `leda_rational` provides exact computation in \f$ \mathbb{R}\f$. +The class `leda_rational` provides exact computation in \f$ \mathbb{Q}\f$. The class `leda_rational` is a wrapper class that provides the functions needed to use the number type `rational`, representing exact multiprecision rational numbers provided by LEDA.