From 17594d2795e9d5edeaf95e6f5dcc3362a5ba8cad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 5 Feb 2018 12:31:40 +0100 Subject: [PATCH] Reduced the amount of \sa in SMP's doc (no need to \sa every other parameterizer) --- .../ARAP_parameterizer_3.h | 6 ------ .../Barycentric_mapping_parameterizer_3.h | 12 +++--------- .../Discrete_authalic_parameterizer_3.h | 6 ------ .../Discrete_conformal_map_parameterizer_3.h | 6 ------ .../LSCM_parameterizer_3.h | 6 ------ .../Mean_value_coordinates_parameterizer_3.h | 6 ------ .../Orbifold_Tutte_parameterizer_3.h | 7 +------ 7 files changed, 4 insertions(+), 45 deletions(-) diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/ARAP_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/ARAP_parameterizer_3.h index 833d2c4f740..5c7fbd73c6e 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/ARAP_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/ARAP_parameterizer_3.h @@ -155,12 +155,6 @@ namespace Surface_mesh_parameterization { /// \endcode /// /// \sa `CGAL::Surface_mesh_parameterization::Fixed_border_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Barycentric_mapping_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_authalic_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_conformal_map_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::LSCM_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Mean_value_coordinates_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Orbifold_Tutte_parameterizer_3` /// template < class TriangleMesh_, class BorderParameterizer_ = Default, diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Barycentric_mapping_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Barycentric_mapping_parameterizer_3.h index dea32baaf23..80e3b1b7fa0 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Barycentric_mapping_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Barycentric_mapping_parameterizer_3.h @@ -72,15 +72,9 @@ namespace Surface_mesh_parameterization { /// Eigen::BiCGSTAB::EigenType, /// Eigen::IncompleteLUT< double > > > /// \endcode -/*! -\sa `CGAL::Surface_mesh_parameterization::Fixed_border_parameterizer_3` -\sa `CGAL::Surface_mesh_parameterization::ARAP_parameterizer_3` -\sa `CGAL::Surface_mesh_parameterization::Discrete_authalic_parameterizer_3` -\sa `CGAL::Surface_mesh_parameterization::Discrete_conformal_map_parameterizer_3` -\sa `CGAL::Surface_mesh_parameterization::LSCM_parameterizer_3` -\sa `CGAL::Surface_mesh_parameterization::Mean_value_coordinates_parameterizer_3` -\sa `CGAL::Surface_mesh_parameterization::Orbifold_Tutte_parameterizer_3` - */ +/// +/// \sa `CGAL::Surface_mesh_parameterization::Fixed_border_parameterizer_3` +/// template < typename TriangleMesh_, typename BorderParameterizer_ = Default, typename SolverTraits_ = Default > diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Discrete_authalic_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Discrete_authalic_parameterizer_3.h index 76d9b7e90ec..4ac35ba2275 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Discrete_authalic_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Discrete_authalic_parameterizer_3.h @@ -78,12 +78,6 @@ namespace Surface_mesh_parameterization { /// \endcode /// /// \sa `CGAL::Surface_mesh_parameterization::Fixed_border_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::ARAP_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Barycentric_mapping_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_conformal_map_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::LSCM_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Mean_value_coordinates_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Orbifold_Tutte_parameterizer_3` /// template < class TriangleMesh_, class BorderParameterizer_ = Default, diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Discrete_conformal_map_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Discrete_conformal_map_parameterizer_3.h index ca3a04dea00..60e376c6baa 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Discrete_conformal_map_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Discrete_conformal_map_parameterizer_3.h @@ -78,12 +78,6 @@ namespace Surface_mesh_parameterization { /// \endcode /// /// \sa `CGAL::Surface_mesh_parameterization::Fixed_border_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::ARAP_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Barycentric_mapping_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_authalic_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::LSCM_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Mean_value_coordinates_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Orbifold_Tutte_parameterizer_3` /// template < typename TriangleMesh_, typename BorderParameterizer_ = Default, diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/LSCM_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/LSCM_parameterizer_3.h index d1d3ac17e17..bfc9eb6588d 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/LSCM_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/LSCM_parameterizer_3.h @@ -87,12 +87,6 @@ namespace Surface_mesh_parameterization { /// \endcode /// /// \sa `CGAL::Surface_mesh_parameterization::Two_vertices_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::ARAP_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Barycentric_mapping_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_authalic_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_conformal_map_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Mean_value_coordinates_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Orbifold_Tutte_parameterizer_3` /// template < class TriangleMesh_, class BorderParameterizer_ = Default, diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Mean_value_coordinates_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Mean_value_coordinates_parameterizer_3.h index 535fbc7f14f..e8afb3ee670 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Mean_value_coordinates_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Mean_value_coordinates_parameterizer_3.h @@ -76,12 +76,6 @@ namespace Surface_mesh_parameterization { /// \endcode /// /// \sa `CGAL::Surface_mesh_parameterization::Fixed_border_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::ARAP_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Barycentric_mapping_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_authalic_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_conformal_map_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::LSCM_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Orbifold_Tutte_parameterizer_3` /// template < class TriangleMesh_, class BorderParameterizer_ = Default, diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Orbifold_Tutte_parameterizer_3.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Orbifold_Tutte_parameterizer_3.h index 85e309b3b2a..40c66bfa68c 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Orbifold_Tutte_parameterizer_3.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/Orbifold_Tutte_parameterizer_3.h @@ -376,12 +376,7 @@ bool locate_unordered_cones(const SeamMesh& mesh, /// Eigen::UmfPackLU::EigenType> > /// \endcode /// -/// \sa `CGAL::Surface_mesh_parameterization::ARAP_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Barycentric_mapping_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_authalic_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Discrete_conformal_map_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::LSCM_parameterizer_3` -/// \sa `CGAL::Surface_mesh_parameterization::Mean_value_coordinates_parameterizer_3` +/// \sa \ref PkgSurfaceParameterizationOrbifoldHelperFunctions /// template < typename SeamMesh, typename SolverTraits_ = Default>