BUGFIX. Fix the documentation

The documentation of parameters::features() was not synced with the actual code.
This commit is contained in:
Laurent Rineau 2012-08-31 14:01:37 +00:00
parent e904968dff
commit c94a2f43c2
2 changed files with 5 additions and 11 deletions

View File

@ -27,19 +27,13 @@ of \ccc{MeshDomainWithFeatures_3}.
\ccInclude{CGAL/refine_mesh_3.h}
\ccGlobalFunction{template <class MeshDomain_3>
Features parameters::features(
\ccGlobalFunction{%
parameters::internal::Features_options parameters::features(
MeshDomain_3 domain);}
Provides a \ccc{Features} value such that
Provides a \ccc{Features_options} value such that
$0$ and $1$-dimensional input features are taken into account
if domain is a model of the refined concept \ccc{MeshDomainWithFeatures_3}.
\ccParameters
The template parameter \ccc{MeshDomain_3} is required to be a model
of \ccc{MeshDomain_3} or \ccc{MeshDomainWithFeatures_3}.
\ccSeeAlso
\ccRefIdfierPage{CGAL::make_mesh_3}, \\

View File

@ -29,8 +29,8 @@ in the mesh.
\ccInclude{CGAL/refine_mesh_3.h}
\ccGlobalFunction{Features parameters::no_features();}
{Return a \ccc{Features} value that prevents the mesh generator
\ccGlobalFunction{parameters::internal::Features_options parameters::no_features();}
{Return a \ccc{Features_options} value that prevents the mesh generator
to take into account $0$ and $1$-dimensional input features.}