mirror of https://github.com/CGAL/cgal
Apply review from Jane
Co-authored-by: Jane Tournois <janetournois@users.noreply.github.com>
This commit is contained in:
parent
9666ae5165
commit
a61e6bc346
|
|
@ -4,7 +4,7 @@ Release History
|
|||
[Release 5.6](https://github.com/CGAL/cgal/releases/tag/v5.6)
|
||||
-----------
|
||||
|
||||
Release date: June 2022
|
||||
Release date: June 2023
|
||||
|
||||
### [Combinatorial Maps](https://doc.cgal.org/5.6/Manual/packages.html#PkgCombinatorialMaps) [Generalized Maps](https://doc.cgal.org/5.6/Manual/packages.html#PkgGeneralizedMaps) [Linear Cell Complex](https://doc.cgal.org/5.6/Manual/packages.html#PkgLinearCellComplex)
|
||||
|
||||
|
|
|
|||
|
|
@ -278,7 +278,7 @@ After Delaunay refinement, angles are in the interval [28.5; 121.9] degrees.
|
|||
After 10 iterations of Lloyd optimization, they are in [29.1; 110.8]. 100 iterations take them to [29.3; 109.9].
|
||||
\cgalFigureEnd
|
||||
|
||||
Since \cgal 5.6, `lloyd_optimize_mesh_2()` uses \ref bgl_namedparameters to set parameters. More details are provided in \ref FromBoostNPtoCGALNP.
|
||||
As of \cgal 5.6, `lloyd_optimize_mesh_2()` uses \ref bgl_namedparameters to set parameters. More details are provided in \ref FromBoostNPtoCGALNP.
|
||||
|
||||
\subsection Mesh_2Examples Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -301,7 +301,7 @@ of the `C3T3`. They can be removed using the function `remove_isolated_vertices(
|
|||
|
||||
\section Mesh_3_section_interface Interface
|
||||
|
||||
Since \cgal 5.6, this packages uses \ref bgl_namedparameters to set parameters. More details are provided in \ref FromBoostNPtoCGALNP.
|
||||
As of \cgal 5.6, this package uses \ref bgl_namedparameters to set parameters. More details are provided in \ref FromBoostNPtoCGALNP.
|
||||
|
||||
\subsection Mesh_3TheGlobalFunctions The Global Functions
|
||||
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ namespace CGAL {
|
|||
* \cgalParamNBegin{sliver_bound}
|
||||
* \cgalParamDescription{is designed to give, in degrees, a targeted lower bound on dihedral angles of mesh cells.
|
||||
* The exudation process considers in turn all the mesh cells that have a smallest dihedral
|
||||
* angle less than sliver_bound and tries to make them disappear by weighting their vertices.
|
||||
* angle less than `sliver_bound` and tries to make them disappear by weighting their vertices.
|
||||
* The optimization process stops when every cell in the mesh achieves this quality. The
|
||||
* default value is 0 and means that there is no targeted bound: the exuder then runs as long
|
||||
* as it can improve the smallest dihedral angles of the set of cells incident to some vertices.}
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ of the manual of 3D periodic triangulations).
|
|||
Thanks to this construction, the meshing process can be exclusively conducted
|
||||
within the canonical cube.
|
||||
The mesh can then be created using the \ref PkgMesh3 package of \cgal.
|
||||
As this package originally aims to mesh non-periodic domains of \f$ \mathbb R^3\f$, an interfacez
|
||||
As this package originally aims to mesh non-periodic domains of \f$ \mathbb R^3\f$, an interface
|
||||
is necessary between the packages \ref PkgMesh3 and \ref PkgPeriodic3Triangulation3.
|
||||
This package provides this interface.
|
||||
|
||||
|
|
@ -250,7 +250,7 @@ for further information.
|
|||
|
||||
\section Periodic_3_mesh_3_section_interface Interface
|
||||
|
||||
Since \cgal 5.6, this packages uses \ref bgl_namedparameters to set parameters. More details are provided in \ref FromBoostNPtoCGALNP.
|
||||
As of \cgal 5.6, this package uses \ref bgl_namedparameters to set parameters. More details are provided in \ref FromBoostNPtoCGALNP.
|
||||
|
||||
\subsection Periodic_3_mesh_3TheGlobalFunctions The Global Functions
|
||||
|
||||
|
|
|
|||
|
|
@ -409,7 +409,7 @@ Mesh_criteria criteria(edge_size = 8,
|
|||
cell_radius_edge_ratio = 3,
|
||||
cell_size = 10);
|
||||
\endcode
|
||||
should now be written as follow:
|
||||
should now be written as follows:
|
||||
\code
|
||||
Mesh_criteria criteria(edge_size(8).
|
||||
facet_angle(25).
|
||||
|
|
@ -422,6 +422,6 @@ Mesh_criteria criteria(edge_size(8).
|
|||
Note that we have tried to preserve the backward compatibility by allowing previous API
|
||||
to remain valid. However, if new parameters are introduced for those functions, there is
|
||||
no guarantee that they will be ported to the old API. So we strongly encourage users to
|
||||
upgrade to the new API. Additionally, passing parameters without names is deprecated or
|
||||
upgrade to the new API. Additionally, passing parameters without names is deprecated
|
||||
and even removed for some functions.
|
||||
*/
|
||||
Loading…
Reference in New Issue