From 2e038ca831aca64cea67b0ab6d6e527f6158d93c Mon Sep 17 00:00:00 2001 From: Jane Tournois Date: Fri, 3 Apr 2015 14:53:18 +0200 Subject: [PATCH] documentation : TriangleMesh is a "triangulated surface mesh" --- .../include/CGAL/Point_inside_polygon_mesh.h | 12 ++++++------ .../include/CGAL/Polygon_mesh_processing/repair.h | 4 ++-- .../Polygon_mesh_processing/self_intersections.h | 4 ++-- .../CGAL/Polygon_mesh_processing/triangulate_faces.h | 2 +- .../include/CGAL/Polygon_mesh_slicer.h | 6 +++--- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/Polygon_mesh_processing/include/CGAL/Point_inside_polygon_mesh.h b/Polygon_mesh_processing/include/CGAL/Point_inside_polygon_mesh.h index e073b89e4f9..44fa76179a6 100644 --- a/Polygon_mesh_processing/include/CGAL/Point_inside_polygon_mesh.h +++ b/Polygon_mesh_processing/include/CGAL/Point_inside_polygon_mesh.h @@ -39,8 +39,8 @@ namespace CGAL { * if an odd number of surfaces is crossed when walking from the point to infinity. * * This class depends on the package \ref PkgAABB_treeSummary. - - * @tparam TriangleMesh a triangulated polyhedral surface, a model of `FaceListGraph` + * + * @tparam TriangleMesh a triangulated surface mesh, model of `FaceListGraph` * @tparam GeomTraits a geometric traits class, model of `Kernel` * @tparam VertexPointMap a model of `ReadablePropertyMap` with `boost::graph_traits::%vertex_descriptor` as key type and @@ -71,8 +71,8 @@ class Point_inside_polygon_mesh public: /** - * Constructor with one surface triangle mesh. - * @param tmesh the triangle mesh bounding the domain to be tested + * Constructor with one triangulated surface mesh. + * @param tmesh the triangulated surface mesh bounding the domain to be tested * @param vpmap the property map with the points associated to the vertices of `tmesh` * @param gt an instance of the geometric traits class * @@ -96,7 +96,7 @@ public: /** * Constructor with one surface triangle mesh, using `get(boost::vertex_point, tmesh)` as * vertex point property map. - * @param tmesh the triangle mesh bounding the domain to be tested + * @param tmesh the triangulated surface mesh bounding the domain to be tested * @param gt an instance of the geometric traits class * * @pre `CGAL::is_closed(tmesh) && CGAL::is_pure_triangle(tmesh)` @@ -117,7 +117,7 @@ public: /** * Constructor that takes a pre-built \cgal `AABB_tree` - * of the triangle mesh primitives. + * of the triangulated surface mesh primitives. * * @param tree a \cgal `AABB_tree` with `AABB_face_graph_triangle_primitive` as `Primitive` type * @param gt an instance of the geometric traits class diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/repair.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/repair.h index dfda651fd5b..f9095da8f30 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/repair.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/repair.h @@ -233,7 +233,7 @@ namespace internal { } // end of namespace internal /// \ingroup PkgPolygonMeshProcessing -/// removes the degenerate faces from a triangle mesh. +/// removes the degenerate faces from a triangulated surface mesh. /// /// @pre `CGAL::is_pure_triangle(tmesh)` /// @@ -241,7 +241,7 @@ namespace internal { /// that has an internal property map for `boost::vertex_point_t` /// @tparam NamedParameters a sequence of \ref namedparameters /// -/// @param tmesh the triangle mesh to be repaired +/// @param tmesh the triangulated surface mesh to be repaired /// @param np optional \ref namedparameters described below /// /// \cgalNamedParamsBegin diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/self_intersections.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/self_intersections.h index b4bfc32c1ae..6743101d54a 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/self_intersections.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/self_intersections.h @@ -214,7 +214,7 @@ self_intersections( const FaceRange& face_range, * `std::pair::%face_descriptor, boost::graph_traits::%face_descriptor>` * @tparam NamedParameters a sequence of \ref namedparameters * - * @param tmesh triangle mesh to be checked + * @param tmesh the triangulated surface mesh to be checked * @param out output iterator to be filled with all pairs of non-adjacent faces that intersect * @param np optional sequence of \ref namedparameters among the ones listed below * @@ -344,7 +344,7 @@ OutputIterator self_intersections(const FaceRange& face_range, * `std::pair::%face_descriptor, boost::graph_traits::%face_descriptor>` * @tparam NamedParameters a sequence of \ref namedparameters * - * @param tmesh triangle mesh to be tested + * @param tmesh the triangulated surface mesh to be tested * @param np optional sequence of \ref namedparameters among the ones listed below * * \cgalNamedParamsBegin diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h index 9c92ea81182..829851e3661 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h @@ -225,7 +225,7 @@ public: /** * \ingroup PkgPolygonMeshProcessing -* triangulates faces of the polygon mesh `pmesh`. This function depends on the package \ref PkgTriangulation2Summary +* triangulates faces of a polygon mesh. This function depends on the package \ref PkgTriangulation2Summary * @tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph` * that has an internal property map for `boost::vertex_point_t` * @tparam NamedParameters a sequence of \ref namedparameters diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h index 7c127afd410..6a52ea895c8 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_slicer.h @@ -44,9 +44,9 @@ namespace CGAL { /// Function object that can compute the intersection of planes with /// a triangulated surface mesh. /// -/// \tparam TriangleMesh triangulated surface mesh. It must be a model of `FaceGraph` and `HalfedgeListGraph` -/// \tparam Traits must be a model of `AABBGeomTraits` -/// \tparam VertexPointMap is a model of `ReadablePropertyMap` with +/// \tparam TriangleMesh a triangulated surface mesh, model of `FaceGraph` and `HalfedgeListGraph` +/// \tparam Traits a model of `AABBGeomTraits` +/// \tparam VertexPointMap a model of `ReadablePropertyMap` with /// `boost::graph_traits::%vertex_descriptor` as key and /// `Traits::Point_3` as value type. /// The default is `typename boost::property_map< TriangleMesh, vertex_point_t>::%type`.