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

verbs are lower case

This commit is contained in:
Sébastien Loriot 2022-03-31 11:39:31 +02:00
parent 1389c517ec
commit 3234d4f50d
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h
View File

@ -71,7 +71,7 @@ typedef unspecified_type Seeds_iterator;
/// @{ /// @{
/*! /*!
Create a new mesher, working on `t`, with meshing criteria creates a new mesher, working on `t`, with meshing criteria
`criteria`. `criteria`.
*/ */
Delaunay_mesher_2(CDT& t, Criteria criteria = Criteria()); Delaunay_mesher_2(CDT& t, Criteria criteria = Criteria());
@ -88,7 +88,7 @@ Delaunay_mesher_2(CDT& t, Criteria criteria = Criteria());
/// @{ /// @{
/*! /*!
Sets seeds to the empty set. All sets seeds to the empty set. All
finite connected components of the constrained triangulation will be finite connected components of the constrained triangulation will be
refined. refined.
*/ */
@ -99,7 +99,7 @@ void clear_seeds ();
/*! /*!
Sets seeds to the sequence `[begin, end)`. If `mark==true`, the mesh domain sets seeds to the sequence `[begin, end)`. If `mark==true`, the mesh domain
is the union of the bounded connected is the union of the bounded connected
components including at least one seed. If components including at least one seed. If
`mark==false`, the domain is the union of `mark==false`, the domain is the union of
@ -148,7 +148,7 @@ by a call to `set_bad_faces`.
/// @{ /// @{
/*! /*!
Refines the constrained Delaunay triangulation into a mesh refines the constrained Delaunay triangulation into a mesh
satisfying the criteria defined by the traits. satisfying the criteria defined by the traits.
*/ */
@ -159,7 +159,7 @@ void refine_mesh();
/*! /*!
Returns a const reference to the criteria traits object. returns a const reference to the criteria traits object.
*/ */
const Criteria& get_criteria(); const Criteria& get_criteria();
@ -168,7 +168,7 @@ const Criteria& get_criteria();
/*! /*!
Assigns `criteria` to the criteria traits object. assigns `criteria` to the criteria traits object.
*/ */
void set_criteria(Criteria criteria); void set_criteria(Criteria criteria);
@ -177,7 +177,7 @@ void set_criteria(Criteria criteria);
/*! /*!
Assigns `criteria` to the criteria traits object. If assigns `criteria` to the criteria traits object. If
`recalculate_bad_faces` is `false`, the list of bad faces is `recalculate_bad_faces` is `false`, the list of bad faces is
let empty and the function `set_bad_faces()` should be called before let empty and the function `set_bad_faces()` should be called before
`refine_mesh`. `refine_mesh`.
@ -259,7 +259,9 @@ bool step_by_step_refine_mesh();
/*! /*!
\ingroup PkgMesh2Functions \ingroup PkgMesh2Functions
Refines the default domain defined by a constrained Delaunay \deprecated This function is deprecated since \cgal 5.5
refines the default domain defined by a constrained Delaunay
triangulation without seeds into a mesh satisfying the criteria triangulation without seeds into a mesh satisfying the criteria
defined by the traits `criteria`. The domain of the mesh defined by the traits `criteria`. The domain of the mesh
covers all the connected components of the plane defined by the covers all the connected components of the plane defined by the
@ -280,7 +282,9 @@ void refine_Delaunay_mesh_2 (CDT &t, const Criteria& criteria = Criteria());
\ingroup PkgMesh2Functions \ingroup PkgMesh2Functions
Refines the default domain defined by a constrained \deprecated This function is deprecated since \cgal 5.5
refines the default domain defined by a constrained
Delaunay triangulation into a mesh Delaunay triangulation into a mesh
satisfying the criteria defined by the traits satisfying the criteria defined by the traits
`criteria`.The sequence `[begin, end)` `criteria`.The sequence `[begin, end)`
@ -310,6 +314,4 @@ InputIterator begin, InputIterator end,
const Criteria& criteria = Criteria(), const Criteria& criteria = Criteria(),
bool mark = false); bool mark = false);
} /* end namespace CGAL */ } /* end namespace CGAL */