From a8820c69a98a34fab1d453bf8f253238426eef01 Mon Sep 17 00:00:00 2001 From: Maxime Gimeno Date: Tue, 28 Jan 2020 13:45:27 +0100 Subject: [PATCH] Doc. --- .../Concepts/GetPlacement.h | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) 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 f9fdbf0d981..da415685d46 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h @@ -1,26 +1,26 @@ -//! -//!\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` +/*! +\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_normal_change_placement` +\cgalHasModel `CGAL::Surface_mesh_simplification::Constrained_placement` +*/ class GetPlacement