From cdc76129d0555174f499ee2a0b92b5fac15c7b2c Mon Sep 17 00:00:00 2001 From: Maxime Gimeno Date: Mon, 14 Nov 2016 10:15:15 +0100 Subject: [PATCH] Keep fixing the doc --- .../doc/Polygon_mesh_processing/Polygon_mesh_processing.txt | 3 +++ .../include/CGAL/Polygon_mesh_processing/distance.h | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt index 2bec5ecc04a..15271fbd503 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt @@ -493,15 +493,18 @@ These computations are performed with : - `CGAL::Polygon_mesh_processing::sample_triangle_mesh()` - `CGAL::Polygon_mesh_processing::sample_face()` +\subsection AHDExample Approximate Hausdorff Distance Example In the following example, a mesh is isotropically remeshed and the approximated distance between the input and the output is computed. \cgalExample{Polygon_mesh_processing/hausdorff_distance_remeshing_example.cpp} +\subsection PoissonDistanceExample Max Distance Between Point Set and Surface Example In the following example, a triangulated surface mesh is constructed from a point set using the \link PkgPoissonSurfaceReconstructionSummary Poisson reconstruction algorithm \endlink, and the distance between the point set and the reconstructed surface is computed. \cgalExample{Poisson_surface_reconstruction_3/poisson_reconstruction_example.cpp} + \section PMPHistory Implementation History A first version of this package was started by Ilker %O. Yaz and Sébastien Loriot. diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/distance.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/distance.h index 06b2b2b0b84..d5ca527fb1a 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/distance.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/distance.h @@ -379,6 +379,7 @@ double approximate_Hausdorff_distance( - `GRID`: points are generated on a grid, with a minimum of one point . - `MONTE_CARLO`: points are generated randomly . The number of points is proportional to the face area with a minimum of 1. * + * @param f the face descriptor of the sampled face. * @param tm the triangle mesh that contains `f` * @param parameter depends on `method`: - `RANDOM_UNIFORM` and `MONTE_CARLO`: the number of points per squared area unit @@ -474,7 +475,7 @@ sample_face(typename boost::graph_traits::face_descriptor f, * * @param tm1 the triangle mesh that will be sampled * @param tm2 the triangle mesh to compute the distance to - * @param precision the number of points per squared area unit for the random sampling + * @param precision the number of points per squared area unit returned by the random sampling * @param np1 optional sequence of \ref namedparameters for `tm1` among the ones listed below * * \cgalNamedParamsBegin