From 0c39f355a5879e90f7a9c9a33d4152dbefd0292c Mon Sep 17 00:00:00 2001 From: Jane Tournois Date: Thu, 10 Sep 2020 12:12:46 +0200 Subject: [PATCH] small fixes in doc --- .../Concepts/PMPTriangulateFaceVisitor.h | 4 ++-- .../CGAL/Polygon_mesh_processing/triangulate_faces.h | 10 +++++++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPTriangulateFaceVisitor.h b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPTriangulateFaceVisitor.h index a9445369792..9b9bbddc64f 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPTriangulateFaceVisitor.h +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPTriangulateFaceVisitor.h @@ -6,7 +6,7 @@ /// the creation of new faces. /// /// \cgalRefines `CopyConstructible` -/// \cgalHasModel `CGAL::Polygon_mesh_processing::Corefinement::Default_visitor`. +/// \cgalHasModel `CGAL::Polygon_mesh_processing::Triangulate_faces::Default_visitor`. class PMPTriangulateFaceVisitor { @@ -22,7 +22,7 @@ typedef unspecified_type face_descriptor; /// the creation of a new face of the triangulation of `f_split`. void before_subface_creations(face_descriptor f_split); - /// called when the triangulation of a face in `tm` is finished + /// called when the triangulation of a face in `tm` is finished. void after_subface_creations(); /// called after creating a new triangle face `f_new` to triangulate the face passed to `before_subface_creations()`. diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h index 0cba62ebd28..7b140d76f16 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h @@ -455,7 +455,7 @@ public: * \cgalParamDefault{`Triangulate_faces::Default_visitor`} * \cgalParamExtra{Note that the visitor will be copied, so * it should not have any data member that does have a reference-like type.} -* `\cgalParamNEnd +* \cgalParamNEnd * \cgalNamedParamsEnd * * @return `true` if the face has been triangulated. @@ -608,6 +608,14 @@ bool triangulate_faces(FaceRange face_range, PolygonMesh& pmesh) * \cgalParamDefault{a \cgal Kernel deduced from the point type, using `CGAL::Kernel_traits`} * \cgalParamExtra{The geometric traits class must be compatible with the vertex point type.} * \cgalParamNEnd +* +* \cgalParamNBegin{triangulate_visitor} +* \cgalParamDescription{a visitor that allows to track how faces are triangulated into subfaces} +* \cgalParamType{a class model of `PMPTriangulateFaceVisitor`} +* \cgalParamDefault{`Triangulate_faces::Default_visitor`} +* \cgalParamExtra{Note that the visitor will be copied, so +* it should not have any data member that does have a reference-like type.} +* \cgalParamNEnd * \cgalNamedParamsEnd * * @return `true` if all the faces have been triangulated.