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

Polish

This commit is contained in:
Andreas Fabri 2023-05-23 09:58:41 +01:00
parent c4d6c23218
commit 0c29013c3d
6 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h
View File

@ -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. Must match the `Cell_handle` type in the
triangulation type used by the mesh generation function. triangulation type used by the mesh generation function.
*/ */

6
Mesh_3/doc/Mesh_3/Concepts/MeshDomainWithFeatures_3.h
View File

@ -17,7 +17,7 @@ between two ordered points on the same curve.
\cgalRefines{MeshDomain_3} \cgalRefines{MeshDomain_3}
\cgalHasModel `CGAL::Mesh_domain_with_polyline_features_3<MeshDomain_3>` \cgalHasModel `CGAL::Mesh_domain_with_polyline_features_3<MD>`
\cgalHasModel `CGAL::Polyhedral_mesh_domain_with_features_3<IGT>` \cgalHasModel `CGAL::Polyhedral_mesh_domain_with_features_3<IGT>`
\sa `MeshDomain_3` \sa `MeshDomain_3`
@ -47,7 +47,7 @@ Point type.
typedef unspecified_type Point_3; 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. of the input domain.
Must be a model of CopyConstructible, Assignable, DefaultConstructible and Must be a model of CopyConstructible, Assignable, DefaultConstructible and
LessThanComparable. The default constructed value must be the value of an edge which 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; 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. of the input domain.
Must be a model of CopyConstructible, Assignable, DefaultConstructible and Must be a model of CopyConstructible, Assignable, DefaultConstructible and
LessThanComparable. LessThanComparable.

2
Mesh_3/doc/Mesh_3/Concepts/MeshDomain_3.h
View File

@ -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 if it includes points which are strictly inside
and strictly outside the domain (resp. the subdomain). and strictly outside the domain (resp. the subdomain).
\cgalHasModel `CGAL::Polyhedral_mesh_domain_3<Polyhedron,IGT,TriangleAccessor>` \cgalHasModel `CGAL::Polyhedral_mesh_domain_3<Polyhedron,IGT>`
\cgalHasModel `CGAL::Labeled_mesh_domain_3<BGT>` \cgalHasModel `CGAL::Labeled_mesh_domain_3<BGT>`
\sa `MeshVertexBase_3` \sa `MeshVertexBase_3`

2
Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h
View File

@ -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); FT sizing_field(const Point_3& p);

5
Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h
View File

@ -5,9 +5,8 @@
The concept `TriangleAccessor_3` represents an accessor to a triangulated polyhedral The concept `TriangleAccessor_3` represents an accessor to a triangulated polyhedral
surface, intersection free and without boundaries. surface, intersection free and without boundaries.
\cgalHasModel `CGAL::Triangle_accessor_3<Polyhedron_3<K>,K>` \cgalHasModel `CGAL::Triangle_accessor_3<Polyhedron,,K>`
\sa `CGAL::Polyhedral_mesh_domain_3<Polyhedron,IGT,TriangleAccessor>`
\sa `CGAL::make_mesh_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; typedef unspecified_type Triangle_handle;
/*! /*!
Polyhedron type. Polyhedron type which must be a model of `FaceGraph`.
*/ */
typedef unspecified_type Polyhedron; typedef unspecified_type Polyhedron;

27
Mesh_3/include/CGAL/Triangle_accessor_3.h
View File

@ -37,23 +37,26 @@ class Triangle_accessor_3 {
/*! /*!
\ingroup PkgMesh3Domains \ingroup PkgMesh3Domains
The class `Triangle_accessor_3` is a model for the concept `TriangleAccessor_3`. It is The class `Triangle_accessor_3` is a model for the concept
designed to serve as accessor for objects of type `Polyhedron_3<K>`. `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 \attention Actually, the class generic class template of
template `template<typename Polyhedron, typename K> `Triangle_accessor_3` must not be used. Partial specializations
Triangle_accessor_3<Polyhedron, K>`. One may give another partial are provided for `CGAL::Polyhedron<K>` and `CGAL::Graph_with_descriptor_with_graph<Surface_mesh<K::Point_3>>`.
specialization of this class to handle one's own polyhedron data structure.
@todo Document the other partial specializations
\tparam Polyhdron must be model of FaceGraph
\tparam K is the geometric traits class. \tparam K is the geometric traits class.
\cgalModels `TriangleAccessor_3` \cgalModels `TriangleAccessor_3`
\sa `CGAL::Polyhedral_mesh_domain_3<Polyhedron,IGT,TriangleAccessor>`
*/ */
#ifdef DOXYGEN_RUNNING
template <typename Polyhedron, typename K>
class Triangle_accessor_3
{};
#else
template < class K,class Items, template < class K,class Items,
template < class T, class I, class A> template < class T, class I, class A>
class T_HDS, class T_HDS,
@ -142,7 +145,7 @@ public:
return Triangle_3(a,b,c); return Triangle_3(a,b,c);
} }
}; };
#endif
} // end namespace CGAL } // end namespace CGAL