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

Merge pull request #2544 from janetournois/PMP-corefinement-improve-doc-GF 

PMP corefinement : improve doc
This commit is contained in:
Laurent Rineau 2017-10-27 18:00:42 +02:00
parent 9873b0f5f5 a7a94ac1d7
commit 666ff0c862
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h
View File

@ -132,9 +132,11 @@ bool recursive_does_bound_a_volume(const TriangleMesh& tm,
* as a named parameter, then it must be initialized. * as a named parameter, then it must be initialized.
* @tparam NamedParameters a sequence of \ref namedparameters * @tparam NamedParameters a sequence of \ref namedparameters
* *
* @param tm a triangulated surface mesh * @param tm a closed triangulated surface mesh
* @param np optional sequence of \ref namedparameters among the ones listed below * @param np optional sequence of \ref namedparameters among the ones listed below
* *
* @pre `CGAL::is_closed(tm)`
*
* \cgalNamedParamsBegin * \cgalNamedParamsBegin
* \cgalParamBegin{vertex_point_map} * \cgalParamBegin{vertex_point_map}
* the property map with the points associated to the vertices of `tm`. * the property map with the points associated to the vertices of `tm`.
@ -142,9 +144,7 @@ bool recursive_does_bound_a_volume(const TriangleMesh& tm,
* `CGAL::vertex_point_t` should be available in `TriangleMesh` * `CGAL::vertex_point_t` should be available in `TriangleMesh`
* \cgalParamEnd * \cgalParamEnd
* \cgalParamBegin{face_index_map} * \cgalParamBegin{face_index_map}
* a property map containing the index of each face of `tm1` (`tm2`). * a property map containing the index of each face of `tm`.
* Note that if the property map is writable, the indices of the faces
* of `tm1` and `tm2` will be set after the corefinement is done.
* \cgalParamEnd * \cgalParamEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
@ -454,7 +454,10 @@ boolean_operation( TriangleMesh& tm1,
* \cgalParamBegin{edge_is_constrained_map} a property map containing the * \cgalParamBegin{edge_is_constrained_map} a property map containing the
* constrained-or-not status of each edge of `tm1` (`tm2`). * constrained-or-not status of each edge of `tm1` (`tm2`).
* \cgalParamEnd * \cgalParamEnd
* \cgalParamBegin{face_index_map} a property map containing the index of each face of `tm1` (`tm2`) \cgalParamEnd * \cgalParamBegin{face_index_map} a property map containing the index of each face of `tm1` (`tm2`).
* Note that if the property map is writable, the indices of the faces
* of `tm1` and `tm2` will be set after the corefinement is done.
* \cgalParamEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
* @param np_out optional sequence of \ref namedparameters among the ones listed below * @param np_out optional sequence of \ref namedparameters among the ones listed below