From bf21e2bd4b616caef6d27597b1a78f1e6676d036 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 29 Jan 2018 21:53:45 +0100 Subject: [PATCH] Minor doc improvements --- .../Orbifold_Tutte_parameterizer_3.h | 10 +++++----- .../orbifold_enums.h | 6 +++--- .../orbifold_shortest_path.h | 19 ++++++++++--------- 3 files changed, 18 insertions(+), 17 deletions(-) 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 65d4a9a8a35..3affb2f23fa 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 @@ -202,8 +202,8 @@ Error_code read_cones(const TriangleMesh& pm, const char* filename, ConeOutputIn /// parameters of the class CGAL::Seam_mesh). /// \tparam ConeInputBidirectionalIterator must be a model of `BidirectionalIterator` /// with value type `boost::graph_traits::%vertex_descriptor`. -/// \tparam ConeMap must be a model of `AssociativeContainer` with -/// `boost::graph_traits::%vertex_descriptor` as key type and +/// \tparam ConeMap must be a model of AssociativeContainer +/// with `boost::graph_traits::%vertex_descriptor` as key type and /// \link PkgSurfaceParameterizationEnums Cone_type \endlink as value type. /// /// \param mesh the seam mesh @@ -893,9 +893,9 @@ public: /// The mapping is piecewise linear (linear in each triangle). /// The result is the (u,v) pair image of each vertex of the 3D surface. /// - /// \tparam ConeMap must be a model of `AssociativeContainer` with key type - /// `boost::graph_traits::%vertex_descriptor` and - /// \link PkgSurfaceParameterizationEnums Cone_type \endlink as value type. + /// \tparam ConeMap must be a model of AssociativeContainer + /// with key type `boost::graph_traits::%vertex_descriptor` and + /// \link PkgSurfaceParameterizationEnums Cone_type \endlink as value type. /// \tparam VertexUVmap must be a model of `ReadWritePropertyMap` with /// `boost::graph_traits::%vertex_descriptor` as key type and /// %Point_2 (type deduced from `Seam_mesh` using `Kernel_traits`) diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_enums.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_enums.h index 247f1c065fa..b634c2197cf 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_enums.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_enums.h @@ -45,9 +45,9 @@ enum Weight_type /// A classification type for the cones used in Orbifold Tutte parameterization. enum Cone_type { - First_unique_cone = 0, ///< marker for the cone found at the beginning of the seam. - Second_unique_cone, ///< marker for the cone found at the end of the seam. - Duplicated_cone ///< marker for all the other cones. Cones are duplicated in the sense + First_unique_cone = 0, ///< Marker for the cone found at the beginning of the seam. + Second_unique_cone, ///< Marker for the cone found at the end of the seam. + Duplicated_cone ///< Marker for all the other cones. Cones are duplicated in the sense /// that when the seam is "opened", the cone appears /// at two different positions. }; diff --git a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_shortest_path.h b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_shortest_path.h index 221a9a49ecc..a2551a7cc5e 100644 --- a/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_shortest_path.h +++ b/Surface_mesh_parameterization/include/CGAL/Surface_mesh_parameterization/orbifold_shortest_path.h @@ -106,18 +106,19 @@ public: /// \ingroup PkgSurfaceParameterizationOrbifoldHelperFunctions /// /// Compute the shortest path between `source` and `target` over `mesh`, using -/// a Dijkstra algorithm. +/// +/// boost::dijkstra_shortest_paths(). /// /// \tparam TriangleMesh A triangle mesh, model of `FaceListGraph` and `HalfedgeListGraph`. /// \tparam EdgeOutputIterator A model of `OutputIterator` with value type -/// `boost::graph_traits::edge_descriptor`. +/// `boost::graph_traits::%edge_descriptor`. /// -/// \param tm the triangular mesh to be parameterized +/// \param mesh the triangular mesh to be parameterized /// \param source, target the extremities of the path to be computed /// \param oi the output iterator /// /// \pre `source` and `target` are vertices of `mesh`. -/// \pre `source != target`. +/// \pre `source != target` template void compute_shortest_paths_between_two_cones(const TriangleMesh& mesh, typename boost::graph_traits::vertex_descriptor source, @@ -169,15 +170,15 @@ void compute_shortest_paths_between_two_cones(const TriangleMesh& mesh, /// /// \tparam TriangleMesh A triangle mesh, model of `FaceListGraph` and `HalfedgeListGraph`. /// \tparam InputConesForwardIterator A model of `ForwardIterator` with value type -/// `boost::graph_traits::vertex_descriptor`. -/// \tparam SeamContainer A model of `SequenceContainer` with value type `boost::graph_traits::edge_descriptor`. +/// `boost::graph_traits::%vertex_descriptor`. +/// \tparam SeamContainer A model of SequenceContainer +/// with value type `boost::graph_traits::%edge_descriptor`. /// /// \param mesh the triangular mesh on which paths are computed -/// \param first, beyond the cones, which form the extremities of the path +/// \param first, beyond a range of cones /// \param seams a container that will store the paths, as a sequence of edges of the mesh. /// -/// \pre `source` and `target` are vertices of `mesh`. -/// \pre `source != target`. +/// \pre `std::distance(first,beyond) > 1` template void compute_shortest_paths_between_cones(const TriangleMesh& mesh, InputConesForwardIterator first, InputConesForwardIterator beyond,