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

cleanup such as usage of \tparam and de-mathmode

This commit is contained in:
Andreas Fabri 2012-09-13 19:42:27 +00:00
parent fa9c95ed7e
commit 2a1db53451
7 changed files with 23 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h
View File

@ -4,11 +4,11 @@ namespace CGAL {
/*!
\ingroup PkgSurfaceMeshSimplification
The class `Surface_mesh_simplification::Count_ratio_stop_predicate` provides a model for the `StopPredicate` concept.
It has one template argument: the type of surface being simplified,
which must be a model of the `EdgeCollapsableMesh` concept.
It returns `true` when the relation between the initial and current number
of edges drops below a certain ratio.
The class `Surface_mesh_simplification::Count_ratio_stop_predicate` is a model for the `StopPredicate` concept
which returns `true` when the relation between the initial and current number of edges drops below a certain ratio.
\tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept.
\models ::StopPredicate
@ -33,7 +33,7 @@ Count_ratio_stop_predicate<ECM>( double ratio );
/// @{
/*!
Returns \f$ ( ((double)current\_count / (double)initial\_count) < ratio)\f$.
Returns ` ( ((double)current_count / (double)initial_count) < ratio)`.
All other parameters are ignored (but exist since this is a generic policy).
*/
bool operator()( FT const& current_cost

10
Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h
View File

@ -4,10 +4,10 @@ namespace CGAL {
/*!
\ingroup PkgSurfaceMeshSimplification
The class `Surface_mesh_simplification::Count_stop_predicate` provides a model for the `StopPredicate` concept.
It has one template argument: the type of surface being simplified,
which must be a model of the `EdgeCollapsableMesh` concept.
It returns `true` when the number of current edges drops below a certain threshold.
The class `Surface_mesh_simplification::Count_stop_predicate` is a model for the `StopPredicate` concept,
which returns `true` when the number of current edges drops below a certain threshold.
\tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept.
\models ::StopPredicate
@ -32,7 +32,7 @@ Count_stop_predicate<ECM>( size_type threshold );
/// @{
/*!
Returns \f$ (current\_count < threshold)\f$. All other parameters are ignored (but exist since this is a generic policy).
Returns `(current_count < threshold)`. All other parameters are ignored (but exist since this is a generic policy).
*/
bool operator()( FT const& current_cost
, Profile const& edge_profile

9
Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h
View File

@ -4,10 +4,11 @@ namespace CGAL {
/*!
\ingroup PkgSurfaceMeshSimplification
The class `Surface_mesh_simplification::Edge_length_cost` provides a model for the `GetCost` concept.
It has one template argument: the type of surface being simplified,
which must be a model of the `EdgeCollapsableMesh` concept.
It computes the collapse cost as the squared length of the edge.
The class `Surface_mesh_simplification::Edge_length_cost` is a model for the `GetCost` concept,
which computes the collapse cost as the squared length of the edge.
\tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept.
\models ::GetCost

4
Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h
View File

@ -5,8 +5,8 @@ namespace CGAL {
\ingroup PkgSurfaceMeshSimplification
The class `Surface_mesh_simplification::Edge_profile` provides a model for the `EdgeProfile` concept.
It has one template argument: the type of surface being simplified,
which must be a model of the `EdgeCollapsableMesh` concept.
\tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept.
\models ::EdgeProfile

3
Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h
View File

@ -8,8 +8,7 @@ The class `Surface_mesh_simplification::LindstromTurk_cost` provides a model for
It computes the collapse cost following the Lindstrom-Turk strategy
(Section \ref SurfaceMeshSimplificationLindstromTurkStrategy)
The class `Surface_mesh_simplification::LindstromTurk_cost` has one template argument: the type of surface being simplified.
It must be a model of the `EdgeCollapsableMesh` concept.
\tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept.
\models ::GetCost

3
Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h
View File

@ -9,8 +9,7 @@ It computes the placement, that is, the new position for the remaining vertex af
a halfedge-collapse, following the Lindstrom-Turk strategy
(Section \ref SurfaceMeshSimplificationLindstromTurkStrategy).
The class `Surface_mesh_simplification::LindstromTurk_placement` has one template argument: the type of surface being simplified.
It must be a model of the `EdgeCollapsableMesh` concept.
\tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept.
\models ::GetPlacement

7
Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h
View File

@ -4,11 +4,10 @@ namespace CGAL {
/*!
\ingroup PkgSurfaceMeshSimplification
The class `Surface_mesh_simplification::Midpoint_placement` provides a model for the `GetPlacement` concept.
It computes the placement as the midpoint position along the edge.
The class `Surface_mesh_simplification::Midpoint_placement` is a model for the `GetPlacement` concept
which computes the placement as the midpoint position along the edge.
The class `Surface_mesh_simplification::Midpoint_placement` has one template arguments: the type of surface being simplified.
It be a model of the `EdgeCollapsableMesh` concept.
\tparam ECM is the type of surface being simplified, and must be a model of the `EdgeCollapsableMesh` concept.
\models ::GetPlacement