From 991efc9034a81f5a090336c11056e9f806e8804f Mon Sep 17 00:00:00 2001 From: Lingjie Zhu Date: Fri, 25 May 2018 10:51:00 +0800 Subject: [PATCH] fix typo and missing \tparam --- .../Surface_mesh_approximation/Concepts/ErrorMetricProxy.h | 7 +++++-- .../surface_mesh_approximation.txt | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/Surface_mesh_approximation/doc/Surface_mesh_approximation/Concepts/ErrorMetricProxy.h b/Surface_mesh_approximation/doc/Surface_mesh_approximation/Concepts/ErrorMetricProxy.h index a1c64471f88..07f8ea2049b 100644 --- a/Surface_mesh_approximation/doc/Surface_mesh_approximation/Concepts/ErrorMetricProxy.h +++ b/Surface_mesh_approximation/doc/Surface_mesh_approximation/Concepts/ErrorMetricProxy.h @@ -25,10 +25,13 @@ public: /// A model of this concept must provide: /// @{ - /// returns fitting error from face f to proxy. + /// Computes and returns fitting error from face f to proxy. FT compute_error(const TriangleMesh &tm, const face_descriptor &f, const Proxy &proxy) const; - /// returns fitted proxy from a range of faces. + /// Computes and returns fitted proxy from a range of faces. + /// @tparam FaceRange range of + /// `boost::graph_traits::%face_descriptor`, model of `Range`. + /// Its iterator type is `InputIterator`. template Proxy fit_proxy(const TriangleMesh &tm, const FaceRange &faces) const; diff --git a/Surface_mesh_approximation/doc/Surface_mesh_approximation/surface_mesh_approximation.txt b/Surface_mesh_approximation/doc/Surface_mesh_approximation/surface_mesh_approximation.txt index 1543d0a4fbf..f6e66320fce 100644 --- a/Surface_mesh_approximation/doc/Surface_mesh_approximation/surface_mesh_approximation.txt +++ b/Surface_mesh_approximation/doc/Surface_mesh_approximation/surface_mesh_approximation.txt @@ -192,7 +192,7 @@ The free function can be used for retrieving the segmentation via proxy ids outp \subsection sma_example3 Class Interface -The class interface `CGAL::Variational_shape_approximation` offers a flexible means to control of the algorithm. The following example uses the `CGAL::L2_metric_planar_proxy` to approximate the shape. +The class interface `CGAL::Variational_shape_approximation` offers a flexible means to control of the algorithm. The following example uses the `CGAL::VSA::L2_metric_plane_proxy` to approximate the shape. \cgalExample{Surface_mesh_approximation/vsa_class_interface_example.cpp}