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

Merge pull request #526 from afabri/PMP-fix_named_params-GF 

fix a type
This commit is contained in:
Sebastien Loriot 2015-12-01 16:35:08 +01:00
parent e1437eefaa 7ba2cf20e2
commit e8c8ea794c
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt
View File

@ -73,7 +73,7 @@ Here is the list of the named parameters available in this package:
\cgalNPBegin{use_delaunay_triangulation} \anchor PMP_use_delaunay_triangulation \cgalNPBegin{use_delaunay_triangulation} \anchor PMP_use_delaunay_triangulation
enables the use of the Delaunay triangulation facet search space for hole filling functions.\n enables the use of the Delaunay triangulation facet search space for hole filling functions.\n
\b Type: boolean \n \b Type: `bool` \n
\b Default value is `true` \b Default value is `true`
\cgalNPEnd \cgalNPEnd
@ -116,7 +116,10 @@ typename CGAL::Kernel_traits<
the property map containing the index of each face of the input polygon mesh.\n the property map containing the index of each face of the input polygon mesh.\n
\b Type: a class model of `ReadablePropertyMap` with \b Type: a class model of `ReadablePropertyMap` with
`boost::graph_traits<PolygonMesh>::%face_descriptor` as key type and `boost::graph_traits<PolygonMesh>::%face_descriptor` as key type and
` boost::face_index_t` as value type.\n the value type
\code typename boost::property_traits<
typename boost::property_map<PolygonMesh, CGAL::face_index_t>::type>::value_type
\endcode
\b Default value is \code boost::get(CGAL::face_index, pmesh)\endcode \b Default value is \code boost::get(CGAL::face_index, pmesh)\endcode
\cgalNPEnd \cgalNPEnd
@ -124,7 +127,10 @@ typename CGAL::Kernel_traits<
the property map containing the index of each vertex of the input polygon mesh.\n the property map containing the index of each vertex of the input polygon mesh.\n
\b Type: a class model of `ReadablePropertyMap` with \b Type: a class model of `ReadablePropertyMap` with
`boost::graph_traits<PolygonMesh>::%vertex_descriptor` as key type and `boost::graph_traits<PolygonMesh>::%vertex_descriptor` as key type and
`CGAL::vertex_index_t` as value type.\n the value type
\code typename boost::property_traits<
typename boost::property_map<PolygonMesh, CGAL::vertex_index_t>::type>::value_type
\endcode
\b Default value is \code boost::get(CGAL::vertex_index, pmesh)\endcode \b Default value is \code boost::get(CGAL::vertex_index, pmesh)\endcode
\cgalNPEnd \cgalNPEnd
@ -139,7 +145,7 @@ algorithm.\n
the property map containing information about edges of the input polygon mesh being constrained or not.\n the property map containing information about edges of the input polygon mesh being constrained or not.\n
\b Type : a class model of `ReadablePropertyMap` with \b Type : a class model of `ReadablePropertyMap` with
`boost::graph_traits<PolygonMesh>::%edge_descriptor` as key type and `boost::graph_traits<PolygonMesh>::%edge_descriptor` as key type and
`bool` as value type.It should be default - constructible.\n `bool` as value type. It should be default constructible.\n
\b Default : if this parameter is omitted, \b Default : if this parameter is omitted,
a default property map where no edge is constrained is provided. a default property map where no edge is constrained is provided.
\cgalNPEnd \cgalNPEnd
@ -148,7 +154,7 @@ a default property map where no edge is constrained is provided.
enables the protection of constraints listed by \ref PMP_edge_is_constrained_map "edge_is_constrained_map" enables the protection of constraints listed by \ref PMP_edge_is_constrained_map "edge_is_constrained_map"
during isotropic remeshing. If `true`, constraint edges cannot be modified at all during isotropic remeshing. If `true`, constraint edges cannot be modified at all
during the remeshing process.\n during the remeshing process.\n
\b Type : boolean \n \b Type : `bool` \n
\b Default value is `false` \b Default value is `false`
\cgalNPEnd \cgalNPEnd