small fixes in other functions

CGAL · Jan 3, 2025 · 791349e · 791349e
1 parent 2777ec7
commit 791349e
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 7 deletions.
diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/detect_features.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/detect_features.h
@@ -247,7 +247,8 @@ void sharp_call(const FT angle_in_deg,
  * \param pmesh the polygon mesh
  * \param angle_in_deg the dihedral angle bound
  * \param edge_is_feature_map the property map that will contain the sharp-or-not status of each edge of `pmesh`
- * \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
+ * \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
+ *        `GT` stands for the type of the object provided to the named parameter `geom_traits()`.
  *
  * \cgalNamedParamsBegin
  *   \cgalParamNBegin{vertex_feature_degree_map}
@@ -256,6 +257,15 @@ void sharp_call(const FT angle_in_deg,
  *     \cgalParamDefault{`boost::get(CGAL::vertex_feature_degree_t(), pmesh)`}
  *   \cgalParamNEnd
  *
+ *   \cgalParamNBegin{vertex_point_map}
+ *     \cgalParamDescription{a property map associating points to the vertices of `pmesh`.}
+ *     \cgalParamType{a class model of `ReadablePropertyMap` with
+ *                    `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
+ *                    as key type and `GT::Point_3` as value type.}
+ *     \cgalParamDefault{`boost::get(CGAL::vertex_point, pmesh)`.}
+ *     \cgalParamExtra{If this parameter is omitted, an internal property map for
+ *                     `CGAL::vertex_point_t` must be available in `PolygonMesh`.}
+*   \cgalParamNEnd
  *   \cgalParamNBegin{geom_traits}
  *     \cgalParamDescription{an instance of a geometric traits class}
  *     \cgalParamType{a class model of `Kernel`}
@@ -313,9 +323,21 @@ void detect_sharp_edges(const PolygonMesh& pmesh,
  * \param pmesh the polygon mesh
  * \param angle_in_deg the dihedral angle bound
  * \param edge_is_feature_map the property map that will contain the sharp-or-not status of each edge of `pmesh`
- * \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
+ * \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
+ *        `GT` stands for the type of the object provided to the named parameter `geom_traits()`.
  *
  * \cgalNamedParamsBegin
+ *
+ *   \cgalParamNBegin{vertex_point_map}
+ *     \cgalParamDescription{a property map associating points to the vertices of `pmesh`.}
+ *     \cgalParamType{a class model of `ReadablePropertyMap` with
+ *                    `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
+ *                    as key type and `GT::Point_3` as value type.}
+ *     \cgalParamDefault{`boost::get(CGAL::vertex_point, pmesh)`.}
+ *     \cgalParamExtra{If this parameter is omitted, an internal property map for
+ *                     `CGAL::vertex_point_t` must be available in `PolygonMesh`.}
+ *   \cgalParamNEnd
+
  *   \cgalParamNBegin{geom_traits}
  *     \cgalParamDescription{an instance of a geometric traits class}
  *     \cgalParamType{a class model of `Kernel`}

diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/fair.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/fair.h
@@ -118,7 +118,7 @@ bool fair(TriangleMesh& tmesh,
 
   @return `true` if fairing is successful, otherwise no vertices are relocated.
 
-  @pre `is_triangle_mesh(tmesh)`
+  @pre `CGAL::is_triangle_mesh(tmesh)`
 
   @warning This function involves linear algebra, that is computed using non-exact, floating-point arithmetic.
 

diff --git a/..._mesh_processing/include/CGAL/Polygon_mesh_processing/interpolated_corrected_curvatures.h b/..._mesh_processing/include/CGAL/Polygon_mesh_processing/interpolated_corrected_curvatures.h
@@ -1095,7 +1095,6 @@ void interpolated_corrected_curvatures(const PolygonMesh& pmesh,
 * \note This function depends on the \eigen 3.1 (or later) library.
 *
 * @tparam PolygonMesh a model of `FaceListGraph`.
-* @tparam VertexDescriptor must be convertible to `boost::graph_traits<PolygonMesh>::%vertex_descriptor`.
 * @tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters".
 *
 * @param pmesh the polygon mesh.
@@ -1163,10 +1162,9 @@ void interpolated_corrected_curvatures(const PolygonMesh& pmesh,
 *
 * \cgalNamedParamsEnd
 */
-template<typename VertexDescriptor,
-         typename PolygonMesh,
+template< typename PolygonMesh,
          typename CGAL_NP_TEMPLATE_PARAMETERS>
-void interpolated_corrected_curvatures(VertexDescriptor v,
+void interpolated_corrected_curvatures(typename boost::graph_traits<PolygonMesh>::vertex_descriptor v,
                                        const PolygonMesh& pmesh,
                                        const CGAL_NP_CLASS& np = parameters::default_values())
 {