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

doc fixes

This commit is contained in:
Jane Tournois 2020-09-10 14:31:48 +02:00
parent 0c39f355a5
commit be7d9d1728
4 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
BGL/include/CGAL/boost/graph/named_params_helper.h
View File

@ -308,7 +308,7 @@ CGAL_DEF_GET_INITIALIZED_INDEX_MAP(face, typename boost::graph_traits<Graph>::fa
} }
template<typename PointRange, template<typename PointRange,
typename NamedParameters = CGAL::Named_function_parameters<bool, internal_np::all_default_t>, typename NamedParameters = Named_function_parameters<bool, internal_np::all_default_t>,
bool has_nested_iterator = internal::Has_nested_type_iterator<PointRange>::value> bool has_nested_iterator = internal::Has_nested_type_iterator<PointRange>::value>
class GetPointMap class GetPointMap
{ {

5
Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt
View File

@ -193,6 +193,11 @@ as shown in the following example.
\cgalExample{Polygon_mesh_processing/triangulate_faces_example.cpp} \cgalExample{Polygon_mesh_processing/triangulate_faces_example.cpp}
An additional parameter, named `triangulate_visitor` can be used to track the how faces
are triangulated into subfaces. The following examples shows how to use it.
\cgalExample{Polygon_mesh_processing/triangulate_faces_split_visitor_example.cpp}
\subsubsection RemeshingExample_1 Isotropic Remeshing of a Region on a Polygon Mesh \subsubsection RemeshingExample_1 Isotropic Remeshing of a Region on a Polygon Mesh

1
Polygon_mesh_processing/doc/Polygon_mesh_processing/examples.txt
View File

@ -29,4 +29,5 @@
\example Polygon_mesh_processing/shape_smoothing_example.cpp \example Polygon_mesh_processing/shape_smoothing_example.cpp
\example Polygon_mesh_processing/locate_example.cpp \example Polygon_mesh_processing/locate_example.cpp
\example Polygon_mesh_processing/orientation_pipeline_example.cpp \example Polygon_mesh_processing/orientation_pipeline_example.cpp
\example Polygon_mesh_processing/triangulate_faces_split_visitor_example.cpp
*/ */

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

@ -450,11 +450,11 @@ public:
* \cgalParamNEnd * \cgalParamNEnd
* *
* \cgalParamNBegin{triangulate_visitor} * \cgalParamNBegin{triangulate_visitor}
* \cgalParamDescription{a visitor that allows to track how faces are triangulated into subfaces} * \cgalParamDescription{a visitor that enables to track how faces are triangulated into subfaces}
* \cgalParamType{a class model of `PMPTriangulateFaceVisitor`} * \cgalParamType{a class model of `PMPTriangulateFaceVisitor`}
* \cgalParamDefault{`Triangulate_faces::Default_visitor<TriangleMesh>`} * \cgalParamDefault{`Triangulate_faces::Default_visitor<PolygonMesh>`}
* \cgalParamExtra{Note that the visitor will be copied, so * \cgalParamExtra{Note that the visitor will be copied, so
* it should not have any data member that does have a reference-like type.} * it must not have any data member that does not have a reference-like type.}
* \cgalParamNEnd * \cgalParamNEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
@ -532,11 +532,11 @@ bool triangulate_face(typename boost::graph_traits<PolygonMesh>::face_descriptor
* \cgalParamNEnd * \cgalParamNEnd
* *
* \cgalParamNBegin{triangulate_visitor} * \cgalParamNBegin{triangulate_visitor}
* \cgalParamDescription{a visitor that allows to track how faces are triangulated into subfaces} * \cgalParamDescription{a visitor that enables to track how faces are triangulated into subfaces}
* \cgalParamType{a class model of `PMPTriangulateFaceVisitor`} * \cgalParamType{a class model of `PMPTriangulateFaceVisitor`}
* \cgalParamDefault{`Triangulate_faces::Default_visitor<TriangleMesh>`} * \cgalParamDefault{`Triangulate_faces::Default_visitor<PolygonMesh>`}
* \cgalParamExtra{Note that the visitor will be copied, so * \cgalParamExtra{Note that the visitor will be copied, so
* it should not have any data member that does have a reference-like type.} * it must not have any data member that does not have a reference-like type.}
* `\cgalParamNEnd * `\cgalParamNEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
@ -610,11 +610,11 @@ bool triangulate_faces(FaceRange face_range, PolygonMesh& pmesh)
* \cgalParamNEnd * \cgalParamNEnd
* *
* \cgalParamNBegin{triangulate_visitor} * \cgalParamNBegin{triangulate_visitor}
* \cgalParamDescription{a visitor that allows to track how faces are triangulated into subfaces} * \cgalParamDescription{a visitor that enables to track how faces are triangulated into subfaces}
* \cgalParamType{a class model of `PMPTriangulateFaceVisitor`} * \cgalParamType{a class model of `PMPTriangulateFaceVisitor`}
* \cgalParamDefault{`Triangulate_faces::Default_visitor<TriangleMesh>`} * \cgalParamDefault{`Triangulate_faces::Default_visitor<PolygonMesh>`}
* \cgalParamExtra{Note that the visitor will be copied, so * \cgalParamExtra{Note that the visitor will be copied, so
* it should not have any data member that does have a reference-like type.} * it must not have any data member that does not have a reference-like type.}
* \cgalParamNEnd * \cgalParamNEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *