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

improve triangulate_faces doc

This commit is contained in:
Sébastien Loriot 2015-03-18 11:43:34 +01:00
parent 262bcb0ce3
commit e93e61230f
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -222,20 +222,24 @@ public:
/**
* \ingroup PkgPolygonMeshProcessing
* Triangulates faces of the polygon mesh `pmesh`. Depends on \ref PkgTriangulation2Summary
* Triangulates faces of the polygon mesh `pmesh`. This function depends on the package \ref PkgTriangulation2Summary
* @tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* @tparam VertexPointMap a model of `ReadablePropertyMap` with
`boost::graph_traits<PolygonMesh>::%vertex_descriptor` as key type and
`Kernel::Point_3` as value type.
* @tparam Kernel Geometric traits class.It can be omitted and deduced automatically from the point type of `PolygonMesh`.
* @tparam Kernel a model of \cgal Kernel.
* @param pmesh the polygon mesh to be modified
* @param vpmap the property map with the points associated to the vertices of `pmesh`.
* @param k a geometric traits class instance, can be omitted
* @param pmesh the polygon mesh to be triangulated
* @param vpmap the property map with the points associated to the vertices of `pmesh`
* @param k an instance of the kernel
*/
template <typename PolygonMesh
, typename VertexPointMap
, typename Kernel>
, typename Kernel
#ifdef DOXYGEN_RUNNING
= CGAL::Kernel_traits< typename boost::property_traits<VertexPointMap>::value_type >::type
#endif
>
void triangulate_faces(PolygonMesh& pmesh
, VertexPointMap vpmap
#ifdef DOXYGEN_RUNNING