diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_distance_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_distance_placement.h index 0a227beabcc..5fa7e3c3395 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_distance_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Bounded_distance_placement.h @@ -2,7 +2,7 @@ namespace CGAL { namespace Surface_mesh_simplification { -/*! +/* \ingroup PkgSurfaceMeshSimplificationRef The class `Bounded_distance_placement` is a model for the concept `GetPlacement`. @@ -28,27 +28,27 @@ class Bounded_distance_placement : public BasePlacement { public: - /// + // typedef typename GeomTraits::FT FT; - /// \name Creation - /// - /// @{ + // \name Creation + // + // @{ - /// The distance bound `d` is used to control that during simplification, - /// no vertex has a distance to the input that would be greater than `d`. + // The distance bound `d` is used to control that during simplification, + // no vertex has a distance to the input that would be greater than `d`. Bounded_distance_placement(const FT d, const BasePlacement& base_placement = BasePlacement()); - /// @} + // @} - /// \name Operations - /// @{ + // \name Operations + // @{ - /// Returns the placement computed by `base_placement`, provided the distance between the input - /// and this placement is smaller than `d`. Otherwise, nothing is returned. + // Returns the placement computed by `base_placement`, provided the distance between the input + // and this placement is smaller than `d`. Otherwise, nothing is returned. boost::optional operator()(const Edge_profile& profile) const; - /// @} + // @} }; } // namespace Surface_Mesh_Simplification diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h index 3ca167ecf05..f9fdbf0d981 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h @@ -1,28 +1,28 @@ -/*! -\ingroup PkgSurfaceMeshSimplificationConcepts -\cgalConcept +//! +//!\ingroup PkgSurfaceMeshSimplificationConcepts +//!\cgalConcept +//! +//!The concept `GetPlacement` describes the requirements for the policy +//!function object which gets the collapse placement of an edge, +//!that is, the new position of the vertex that remains after a +//!halfedge-collapse operation. +//! +//!The placement returned is a `boost::optional` value (i.e., it can +//!be absent). An absent result indicates that the edge should not be collapsed. +//!This could be the result of a computational limitation (such as an overflow), +//!or can be intentionally returned to prevent the edge from being collapsed. +//! +//!\cgalRefines `DefaultConstructible` +//!\cgalRefines `CopyConstructible` +//! +//!\cgalHasModel `CGAL::Surface_mesh_simplification::Midpoint_placement` +//!\cgalHasModel `CGAL::Surface_mesh_simplification::LindstromTurk_placement` +//!\cgalHasModel `CGAL::Surface_mesh_simplification::GarlandHeckbert_policies` +//\cgalHasModel `CGAL::Surface_mesh_simplification::Bounded_distance_placement` +//!\cgalHasModel `CGAL::Surface_mesh_simplification::Bounded_normal_change_placement` +//!\cgalHasModel `CGAL::Surface_mesh_simplification::Constrained_placement` -The concept `GetPlacement` describes the requirements for the policy -function object which gets the collapse placement of an edge, -that is, the new position of the vertex that remains after a -halfedge-collapse operation. -The placement returned is a `boost::optional` value (i.e., it can -be absent). An absent result indicates that the edge should not be collapsed. -This could be the result of a computational limitation (such as an overflow), -or can be intentionally returned to prevent the edge from being collapsed. - -\cgalRefines `DefaultConstructible` -\cgalRefines `CopyConstructible` - -\cgalHasModel `CGAL::Surface_mesh_simplification::Midpoint_placement` -\cgalHasModel `CGAL::Surface_mesh_simplification::LindstromTurk_placement` -\cgalHasModel `CGAL::Surface_mesh_simplification::GarlandHeckbert_policies` -\cgalHasModel `CGAL::Surface_mesh_simplification::Bounded_distance_placement` -\cgalHasModel `CGAL::Surface_mesh_simplification::Bounded_normal_change_placement` -\cgalHasModel `CGAL::Surface_mesh_simplification::Constrained_placement` - -*/ class GetPlacement { public: diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt index 6ff97276f7e..9cec933f869 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt @@ -43,7 +43,6 @@ - `CGAL::Surface_mesh_simplification::LindstromTurk_cost` - `CGAL::Surface_mesh_simplification::LindstromTurk_placement` - `CGAL::Surface_mesh_simplification::GarlandHeckbert_policies` -- `CGAL::Surface_mesh_simplification::Bounded_distance_placement` - `CGAL::Surface_mesh_simplification::Bounded_normal_change_placement` - `CGAL::Surface_mesh_simplification::Constrained_placement` */