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

fix documentation in Nef_2

This commit is contained in:
Andreas Fabri 2015-03-23 11:03:32 +01:00
parent 39f0768623
commit 0c4902a2dc
6 changed files with 12 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldNumberType.h
View File

@ -17,9 +17,9 @@ for Cartesian kernels.
\cgalHasModel \ref CGAL::Interval_nt_advanced \cgalHasModel \ref CGAL::Interval_nt_advanced
\cgalHasModel `CGAL::Lazy_exact_nt<FieldNumberType>` \cgalHasModel `CGAL::Lazy_exact_nt<FieldNumberType>`
\cgalHasModel `CGAL::Quotient<RingNumberType>` \cgalHasModel `CGAL::Quotient<RingNumberType>`
\cgalHasModel `CGAL::leda_rational` \cgalHasModel `leda_rational`
\cgalHasModel `CGAL::leda_bigfloat` \cgalHasModel `leda_bigfloat`
\cgalHasModel `CGAL::leda_real` \cgalHasModel `leda_real`
\sa `RingNumberType` \sa `RingNumberType`
\sa `Kernel` \sa `Kernel`

8
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RingNumberType.h
View File

@ -20,10 +20,10 @@ for Homogeneous kernels.
\cgalHasModel `CGAL::MP_Float` \cgalHasModel `CGAL::MP_Float`
\cgalHasModel `CGAL::Gmpzf` \cgalHasModel `CGAL::Gmpzf`
\cgalHasModel `CGAL::Quotient<RingNumberType>` \cgalHasModel `CGAL::Quotient<RingNumberType>`
\cgalHasModel `CGAL::leda_integer` \cgalHasModel `leda_integer`
\cgalHasModel `CGAL::leda_rational` \cgalHasModel `leda_rational`
\cgalHasModel `CGAL::leda_bigfloat` \cgalHasModel `leda_bigfloat`
\cgalHasModel `CGAL::leda_real` \cgalHasModel `leda_real`
\sa `FieldNumberType` \sa `FieldNumberType`

6
Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h
View File

@ -10,11 +10,7 @@ representation based on a field number type `FT`.
\cgalModels `ExtendedKernelTraits_2` \cgalModels `ExtendedKernelTraits_2`
\cgalHeading{Requirements} \tparam FT must be a model of `FieldNumberType`.
To make a field number type `FT_model` work with this class, you
must provide a specialization of the traits class
`Number_type_traits<FT_model>`

9
Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h
View File

@ -10,15 +10,8 @@ representation based on a Euclidean ring number type `RT`.
\cgalModels `ExtendedKernelTraits_2` \cgalModels `ExtendedKernelTraits_2`
\cgalHeading{Requirements}
To make an Euclidean ring number type \tparam RT must be a model of `RingNumberType`.
`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.
\sa `CGAL::Extended_cartesian<FT>` \sa `CGAL::Extended_cartesian<FT>`

2
Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h
View File

@ -10,6 +10,8 @@ representation based on a ring number type `RT`.
\cgalModels `ExtendedKernelTraits_2` \cgalModels `ExtendedKernelTraits_2`
\tparam RT must be a model of `RingNumberType`.
\sa `CGAL::Extended_cartesian<FT>` \sa `CGAL::Extended_cartesian<FT>`
\sa `CGAL::Extended_homogeneous<RT>` \sa `CGAL::Extended_homogeneous<RT>`

2
Number_types/doc/Number_types/CGAL/leda_rational.h
View File

@ -2,7 +2,7 @@
/*! /*!
\ingroup nt_leda \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 The class `leda_rational` is a wrapper class that provides the functions
needed to use the number type `rational`, representing exact needed to use the number type `rational`, representing exact
multiprecision rational numbers provided by <span class="textsc">LEDA</span>. multiprecision rational numbers provided by <span class="textsc">LEDA</span>.