From c41bc2250d9d29ed04584d5b78eee95643bac91a Mon Sep 17 00:00:00 2001
From: Jane Tournois <jane.tournois@geometryfactory.com>
Date: Wed, 20 May 2015 16:52:28 +0200
Subject: [PATCH] start documentation for get_border and
 incremental_triangle_based_remeshing

---
 .../CGAL/Polygon_mesh_processing/get_border.h | 16 +++++++---
 .../CGAL/Polygon_mesh_processing/remesh.h     | 30 +++++++++++++------
 2 files changed, 33 insertions(+), 13 deletions(-)

diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/get_border.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/get_border.h
index 32fc01ca49c..f9887e61f13 100644
--- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/get_border.h
+++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/get_border.h
@@ -29,11 +29,19 @@
 namespace CGAL{
 namespace Polygon_mesh_processing {
 
-  /**
+  /*!
+  \ingroup PkgPolygonMeshProcessing
   * collects the border of a face range
-  * @param faces the range of face descriptors around which the
-  *              border is computed
-  * @param out the output iterator that collects edges that form the border
+
+  * @tparam PolygonMesh model of `HalfedgeGraph`
+  * @tparam FaceRange
+  * @tparam HalfedgeOutputIterator model of `OutputIterator`
+     holding `boost::graph_traits<PolygonMesh>::%halfedge_descriptor`
+     for patch border
+
+  * @param faces the range of face descriptors describing the surface patch
+  *              around which the border is computed
+  * @param out the output iterator that collects halfedges that form the border
   *            of `faces`, seen from inside the surface patch
   *
   * @todo code : what shall we do for more than one connected components
diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh.h
index b242d3f4082..122b0126388 100644
--- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh.h
+++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh.h
@@ -32,22 +32,34 @@ namespace CGAL {
 
 namespace Polygon_mesh_processing {
 
-/**
+/*!
 * \ingroup PkgPolygonMeshProcessing
+* @brief remeshes a triangulated region of a polygon mesh.
 * implements section 6.5.3 "Incremental remeshing" from the PMP book
+*
 * @tparam PolygonMesh model of `MutableFaceGraph` that 
 *         has an internal property map for `CGAL::vertex_point_t`
-* @tparam FaceRange range of face descriptors, model of `SinglePassRange`
+* @tparam FaceRange range of `boost::graph_traits<PolygonMesh>::%face_descriptor`,
+          model of `Range`. Its iterator type is `InputIterator`.
+* @tparam NamedParameters a sequence of \ref namedparameters
 *
-* @param pmesh polygon mesh with patches to be refined 
+* @param pmesh polygon mesh with patches to be remeshed
 * @param faces the range of faces defining one patch to remesh
+* @param target_edge_length the edge length that is targetted in the remeshed patch
+* @param np optional sequence of \ref namedparameters among the ones listed below
+
+* \cgalNamedParamsBegin
+*  \cgalParamBegin{vertex_point_map} the property map with the points associated
+*    to the vertices of `pmesh`. Instance of a class model of `ReadWritePropertyMap`.
+*  \cgalParamEnd
+*  \cgalParamBegin{number_of_iterations} TODO...
+*  \cgalParamEnd
+*  \cgalParamBegin{geom_traits} a geometric traits class instance 
+   \cgalParamEnd
+* \cgalNamedParamsEnd
 *
-* named parameters :
-* vertex_point_map
-* nb_iterations
-* geom_traits, that needs Point_3, Vector_3, Plane_3
-*
-*@todo we suppose `faces` describe only one patch. Handle several patches
+*@todo we suppose `faces` describe only one patch. Handle several patches.
+*@todo document `number_of_iterations`
 */
 template<typename PolygonMesh
        , typename FaceRange