From 2a1db53451dd8cae6626f7015ab31215734bbd7c Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 13 Sep 2012 19:42:27 +0000 Subject: [PATCH] cleanup such as usage of \tparam and de-mathmode --- .../Edge_collapse/Count_ratio_stop_predicate.h | 12 ++++++------ .../Policies/Edge_collapse/Count_stop_predicate.h | 10 +++++----- .../Policies/Edge_collapse/Edge_length_cost.h | 9 +++++---- .../Policies/Edge_collapse/Edge_profile.h | 4 ++-- .../Policies/Edge_collapse/LindstromTurk_cost.h | 3 +-- .../Policies/Edge_collapse/LindstromTurk_placement.h | 3 +-- .../Policies/Edge_collapse/Midpoint_placement.h | 7 +++---- 7 files changed, 23 insertions(+), 25 deletions(-) diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h index b6a00d664a4..8f1aa8dd0c0 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h @@ -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( 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 diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h index 5781aebd9a7..10ba292b295 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h @@ -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( 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 diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h index ebf80b915f7..323613f9b9f 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h @@ -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 diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h index d8157ef03f4..385fd5f4358 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_profile.h @@ -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 diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h index adaa719bbce..85e89d3c275 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h @@ -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 diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h index 4369c161818..b5282d96d99 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h @@ -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 diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h index f2ba9acf4cd..56cf4b4926d 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h @@ -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