From f09c8d9a57b55a7ef63e051b5a45920eb23461ea Mon Sep 17 00:00:00 2001 From: Jane Tournois Date: Thu, 12 Sep 2024 12:26:56 +0200 Subject: [PATCH] cleaning --- Mesh_3/doc/Mesh_3/CGAL/Mesh_3/parameters.h | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_3/parameters.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_3/parameters.h index 003ced5956a..4e400391ba1 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_3/parameters.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_3/parameters.h @@ -454,14 +454,17 @@ unspecified_type perturb(const Named_function_parameters& np = parameters::defau /*! * \ingroup PkgMesh3Parameters * - * The function `parameters::initial_points_generator()` allows the user to specify a functor that follows the `InitialPointsGenerator` concept to the mesh generation function `make_mesh_3()`. This functor will be called for the initialization of the meshing process. If this parameter is specified without arguments, the default behavior is executed, which calls the domain's `construct_initial_points_object()` for the initialization of the meshing process. + * The function `parameters::initial_points_generator()` allows the user to specify a functor that follows + * the `InitialPointsGenerator` concept to the mesh generation function `make_mesh_3()`. This functor will be called + * for the initialization of the meshing process. If this parameter is specified without arguments, the default behavior + * is executed, which calls the domain's `construct_initial_points_object()` for the initialization of the meshing process. * * If the generator does not generate enough points, the domain's `construct_initial_points_object()` will be called. * If the parameter `parameters::initial_points()` is set, the functor will be called after insertion of the points. * * \tparam InitialPointsGenerator a functor that follows the `InitialPointsGenerator` concept * - * @param generator an instance of the InitialPointsGenerator functor + * @param generator an instance of `InitialPointsGenerator` * * \cgalHeading{Example} * @@ -477,7 +480,10 @@ unspecified_type initial_points_generator(const InitialPointsGenerator& generato /*! * \ingroup PkgMesh3Parameters * - * The function `parameters::initial_points()` allows the user to specify a container model of `Range` that contains initial points to be used in the `make_mesh_3()` function for mesh generation. The `Range` should have elements of type `std::tuple`, where `Weighted_point_3` represents the position and weight of the point, `int` represents the dimension of the minimal subcomplex on which the point lies, and `Index` represents the underlying subcomplex index. + * The function `parameters::initial_points()` allows the user to specify a container model of `Range` that contains + * initial points to be used in the `make_mesh_3()` function for mesh generation. The `Range` should have elements of type + * `std::tuple`, where `Weighted_point_3` represents the position and weight of the point, + * `int` represents the dimension of the minimal subcomplex on which the point lies, and `Index` represents the underlying subcomplex index. * * If this parameter is set, the domain's `construct_initial_points_object()` will not be called. * If the parameter `parameters::initial_points_generator()` is set, the points will be inserted before calling the functor.