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

fix linking in \hasModel by backquoting

This commit is contained in:
Andreas Fabri 2012-08-27 13:40:53 +00:00
parent fd1c486d8d
commit 7b9e531c65
3 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h
View File

@ -6,7 +6,7 @@
The concept `DataKernel` describes the set of requirements to be
fulfilled by any class used to instantiate first template parameter of
the class
`Monge_via_jet_fitting<DataKernel,LocalKernel,SvdTraits>`.
`CGAL::Monge_via_jet_fitting<DataKernel,LocalKernel,SvdTraits>`.
Operations
--------------
@ -14,7 +14,8 @@ Operations
Only constructors (from 3 scalars and copy constructors) and access
methods to coordinates `x()`, `y()`, `z()` are needed.
\hasModel CGAL::Cartesian<FieldNumberType>
\hasModel `CGAL::Cartesian<FieldNumberType>`
\hasModel `CGAL::Simple_cartesian<FieldNumberType>`
\sa ::LocalKernel

9
Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h
View File

@ -6,16 +6,16 @@
The concept `LocalKernel` describes the set of requirements to be
fulfilled by any class used to instantiate the second template
parameter of the class
`Monge_via_jet_fitting<DataKernel,LocalKernel,SvdTraits>`.
`CGAL::Monge_via_jet_fitting<DataKernel,LocalKernel,SvdTraits>`.
This concept provides the geometric primitives used for the
computations in the class
`Monge_via_jet_fitting`.
`CGAL::Monge_via_jet_fitting`.
Requirements
--------------
In the class `Monge_via_jet_fitting` the scalar type,
In the class `CGAL::Monge_via_jet_fitting` the scalar type,
`LocalKernel::FT`, must be the same as that of the `SvdTraits`
concept : `SvdTraits::FT`.
@ -31,7 +31,8 @@ Only constructors (from 3 scalars and copy constructors) and access
methods to coordinates `x()`, `y()`, `z()` are needed for the point and
vector types.
\hasModel CGAL::Cartesian<FieldNumberType>
\hasModel `CGAL::Cartesian<FieldNumberType>`
\hasModel `CGAL::Simple_cartesian<FieldNumberType>`
\sa ::DataKernel
\sa ::SvdTraits

8
Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h
View File

@ -5,10 +5,10 @@
The concept `SvdTraits` describes the set of requirements to be
fulfilled by any class used to instantiate the third template
parameter of the class
`Monge_via_jet_fitting<DataKernel,LocalKernel,SvdTraits>`.
`CGAL::Monge_via_jet_fitting<DataKernel,LocalKernel,SvdTraits>`.
It describes the linear algebra types and algorithms needed by the
class `Monge_via_jet_fitting`.
class `CGAL::Monge_via_jet_fitting`.
Requirements
--------------
@ -16,8 +16,8 @@
The scalar type, `SvdTraits::FT`, must be the same as that of
the `LocalKernel` concept : `LocalKernel::FT`.
\hasModel `Eigen_svd`
\hasModel `Lapack_svd`
\hasModel `CGAL::Eigen_svd`
\hasModel `CGAL::Lapack_svd`
\sa `LocalKernel`