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

small fixes in doc

This commit is contained in:
Jane Tournois 2020-09-10 12:12:46 +02:00
parent 39e75e7530
commit 0c39f355a5
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPTriangulateFaceVisitor.h
View File

@ -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()`.

10
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h
View File

@ -455,7 +455,7 @@ public:
* \cgalParamDefault{`Triangulate_faces::Default_visitor<TriangleMesh>`}
* \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<TriangleMesh>`}
* \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.