From 0c29013c3d45cb49505127e1f69503bacbc7f087 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Tue, 23 May 2023 09:58:41 +0100 Subject: [PATCH] Polish --- .../doc/Mesh_3/Concepts/MeshCellCriteria_3.h | 2 +- .../Concepts/MeshDomainWithFeatures_3.h | 6 ++--- Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h | 2 +- .../doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h | 2 +- .../doc/Mesh_3/Concepts/TriangleAccessor_3.h | 5 ++-- Mesh_3/include/CGAL/Triangle_accessor_3.h | 27 ++++++++++--------- 6 files changed, 23 insertions(+), 21 deletions(-) diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h index d3b0b83f0a6..242c25189b5 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h @@ -26,7 +26,7 @@ public: /// @{ /*! -Handle type for the cells of the +%Handle type for the cells of the triangulation. Must match the `Cell_handle` type in the triangulation type used by the mesh generation function. */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h index 18e97b9a275..8e91075c581 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h @@ -17,7 +17,7 @@ between two ordered points on the same curve. \cgalRefines{MeshDomain_3} -\cgalHasModel `CGAL::Mesh_domain_with_polyline_features_3` +\cgalHasModel `CGAL::Mesh_domain_with_polyline_features_3` \cgalHasModel `CGAL::Polyhedral_mesh_domain_with_features_3` \sa `MeshDomain_3` @@ -47,7 +47,7 @@ Point type. typedef unspecified_type Point_3; /*! -Type of indices for curves (i.e. \f$ 1\f$-dimensional features) +Type of indices for curves (i.e., \f$ 1\f$-dimensional features) of the input domain. Must be a model of CopyConstructible, Assignable, DefaultConstructible and LessThanComparable. The default constructed value must be the value of an edge which @@ -56,7 +56,7 @@ does not approximate a 1-dimensional feature of the input domain. typedef unspecified_type Curve_index; /*! -Type of indices for corners (i.e.\f$ 0\f$--dimensional features) +Type of indices for corners (i.e., \f$ 0\f$--dimensional features) of the input domain. Must be a model of CopyConstructible, Assignable, DefaultConstructible and LessThanComparable. diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h index 240f9b0f1fb..929790c0d46 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h @@ -29,7 +29,7 @@ A segment, ray or line is said to intersect properly the domain boundary if it includes points which are strictly inside and strictly outside the domain (resp. the subdomain). -\cgalHasModel `CGAL::Polyhedral_mesh_domain_3` +\cgalHasModel `CGAL::Polyhedral_mesh_domain_3` \cgalHasModel `CGAL::Labeled_mesh_domain_3` \sa `MeshVertexBase_3` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h index 4c044751069..50b9374fa98 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h @@ -46,7 +46,7 @@ typedef unspecified_type FT; /*! -Returns the value of the sizing field (i.e.\ the maximum edge length) at point `p`. +Returns the value of the sizing field (i.e., the maximum edge length) at point `p`. */ FT sizing_field(const Point_3& p); diff --git a/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h b/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h index 958e64ea360..5df33f35db1 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h @@ -5,9 +5,8 @@ The concept `TriangleAccessor_3` represents an accessor to a triangulated polyhedral surface, intersection free and without boundaries. -\cgalHasModel `CGAL::Triangle_accessor_3,K>` +\cgalHasModel `CGAL::Triangle_accessor_3` -\sa `CGAL::Polyhedral_mesh_domain_3` \sa `CGAL::make_mesh_3()` */ @@ -36,7 +35,7 @@ constructible from `Triangle_iterator`. It may be `Triangle_iterator` itself. typedef unspecified_type Triangle_handle; /*! -Polyhedron type. +Polyhedron type which must be a model of `FaceGraph`. */ typedef unspecified_type Polyhedron; diff --git a/Mesh_3/include/CGAL/Triangle_accessor_3.h b/Mesh_3/include/CGAL/Triangle_accessor_3.h index cba5e955c7d..578833fd494 100644 --- a/Mesh_3/include/CGAL/Triangle_accessor_3.h +++ b/Mesh_3/include/CGAL/Triangle_accessor_3.h @@ -37,23 +37,26 @@ class Triangle_accessor_3 { /*! \ingroup PkgMesh3Domains -The class `Triangle_accessor_3` is a model for the concept `TriangleAccessor_3`. It is -designed to serve as accessor for objects of type `Polyhedron_3`. +The class `Triangle_accessor_3` is a model for the concept +`TriangleAccessor_3`. It is no longer used in the 3D Mesh +Generation package, and it is only kept for backward compatibility. -\attention Actually, the class `Triangle_accessor_3` is a partial specialization of the class -template `template -Triangle_accessor_3`. One may give another partial -specialization of this class to handle one's own polyhedron data structure. - -@todo Document the other partial specializations +\attention Actually, the class generic class template of +`Triangle_accessor_3` must not be used. Partial specializations +are provided for `CGAL::Polyhedron` and `CGAL::Graph_with_descriptor_with_graph>`. +\tparam Polyhdron must be model of FaceGraph \tparam K is the geometric traits class. \cgalModels `TriangleAccessor_3` - -\sa `CGAL::Polyhedral_mesh_domain_3` - */ + +#ifdef DOXYGEN_RUNNING +template +class Triangle_accessor_3 +{}; + +#else template < class K,class Items, template < class T, class I, class A> class T_HDS, @@ -142,7 +145,7 @@ public: return Triangle_3(a,b,c); } }; - +#endif } // end namespace CGAL