From 56cb0a66a3cd3f437025b0a30db23022b7585608 Mon Sep 17 00:00:00 2001 From: Maxime Gimeno Date: Wed, 2 Aug 2017 09:46:16 +0200 Subject: [PATCH] Changes after review --- .../IO/facets_in_complex_3_to_triangle_mesh.h | 6 ++--- .../IO/facets_in_complex_3_to_triangle_mesh.h | 6 ++--- .../IO/facets_in_complex_2_to_triangle_mesh.h | 6 ++--- .../IO/output_surface_facets_to_polyhedron.h | 23 +++++++------------ .../IO/facets_in_complex_2_to_triangle_mesh.h | 6 ++--- .../IO/output_surface_facets_to_polyhedron.h | 5 +--- 6 files changed, 21 insertions(+), 31 deletions(-) diff --git a/Mesh_3/doc/Mesh_3/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h b/Mesh_3/doc/Mesh_3/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h index 33eb3ee8f6b..28b35dfc2cc 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h +++ b/Mesh_3/doc/Mesh_3/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h @@ -3,13 +3,13 @@ namespace CGAL { //! //! Builds a `TriangleMesh` from the surface facets, with a consistent orientation at the interface of two subdomains. //! -//! This variant exports the surface as a `TriangleMesh` and appends it to `graph`, using +//! This function exports the surface as a `TriangleMesh` and appends it to `graph`, using //! `orient_polygon_soup()`. //! -//! @tparam C3T3 model of the `MeshComplexWithFeatures_3InTriangulation_3` concept. +//! @tparam C3T3 a model of `MeshComplexWithFeatures_3InTriangulation_3`. //! @tparam TriangleMesh a model of `MutableFaceGraph` with an internal point property map //! -//! @param c3t3 an instance of a `C3T3`. +//! @param c3t3 an instance of `C3T3`. //! @param graph an instance of `TriangleMesh`. template void facets_in_complex_3_to_triangle_mesh(const C3T3& c3t3, TriangleMesh& graph); diff --git a/Mesh_3/include/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h b/Mesh_3/include/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h index 38f11d4cb9f..367eb7cd8e7 100644 --- a/Mesh_3/include/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h +++ b/Mesh_3/include/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h @@ -35,13 +35,13 @@ namespace CGAL { //! //! Builds a `TriangleMesh` from the surface facets, with a consistent orientation at the interface of two subdomains. //! -//! This variant exports the surface as a `TriangleMesh` and appends it to `graph`, using +//! This function exports the surface as a `TriangleMesh` and appends it to `graph`, using //! `orient_polygon_soup()`. //! -//! @tparam C3T3 model of the `MeshComplexWithFeatures_3InTriangulation_3` concept. +//! @tparam C3T3 a model of `MeshComplexWithFeatures_3InTriangulation_3`. //! @tparam TriangleMesh a model of `MutableFaceGraph` with an internal point property map //! -//! @param c3t3 an instance of a `C3T3`. +//! @param c3t3 an instance of `C3T3`. //! @param graph an instance of `TriangleMesh`. template void facets_in_complex_3_to_triangle_mesh(const C3T3& c3t3, TriangleMesh& graph) //complexity nlogn(number of facets on surface) diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/IO/facets_in_complex_2_to_triangle_mesh.h b/Surface_mesher/doc/Surface_mesher/CGAL/IO/facets_in_complex_2_to_triangle_mesh.h index 38a1a976f7d..18a57d1c43c 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/IO/facets_in_complex_2_to_triangle_mesh.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/IO/facets_in_complex_2_to_triangle_mesh.h @@ -5,15 +5,15 @@ namespace CGAL { \brief Converts a manifold surface reconstructed by `make_surface_mesh()` to a `TriangleMesh`. - This variant exports the surface as a `TriangleMesh` and appends it to `graph`. + This function exports the surface as a `TriangleMesh` and appends it to `graph`. It must be manifold. For this purpose, you may call `make_surface_mesh()` with `Manifold_tag` or `Manifold_with_boundary_tag` parameter. - @tparam C2T3 model of the `SurfaceMeshComplex_2InTriangulation_3` concept. + @tparam C2T3 a model of `SurfaceMeshComplex_2InTriangulation_3`. @tparam TriangleMesh a model of `MutableFaceGraph`. - @param c2t3 an instance of a manifold `C2T3`. + @param c2t3 a manifold instance of `C2T3`. @param graph an instance of `TriangleMesh`. \sa `CGAL::output_surface_facets_to_off()` diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h b/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h index 12f9bc3220c..97730ca2496 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h @@ -1,24 +1,17 @@ namespace CGAL { /*! -\ingroup PkgSurfaceMesher3FunctionsIO +\deprecated Gets reconstructed surface out of a SurfaceMeshComplex_2InTriangulation_3 object. -converts a manifold surface reconstructed by `make_surface_mesh()` to a `Polyhedron_3`. +This variant exports the surface as a polyhedron. +It requires the surface to be manifold. For this purpose, +you may call make_surface_mesh() with Manifold_tag or Manifold_with_boundary_tag parameter. -The surface must be manifold. For this purpose, you may call -`make_surface_mesh()` with `Manifold_tag` or -`Manifold_with_boundary_tag` parameter. +@commentheading Template Parameters: +@param SurfaceMeshComplex_2InTriangulation_3 model of the SurfaceMeshComplex_2InTriangulation_3 concept. +@param Polyhedron an instance of CGAL::Polyhedron_3. -\tparam SurfaceMeshComplex_2InTriangulation_3 must be a model of the `SurfaceMeshComplex_2InTriangulation_3` concept. -\tparam Polyhedron must be an instance of `Polyhedron_3`. - -\returns `true` if the surface is manifold and orientable. - - -\param c2t3 Input surface. -\param output_polyhedron Output polyhedron. - -\sa `CGAL::output_surface_facets_to_off()` +@return true if the surface is manifold and orientable. */ template bool output_surface_facets_to_polyhedron(const SurfaceMeshComplex_2InTriangulation_3& c2t3, Polyhedron& output_polyhedron); diff --git a/Surface_mesher/include/CGAL/IO/facets_in_complex_2_to_triangle_mesh.h b/Surface_mesher/include/CGAL/IO/facets_in_complex_2_to_triangle_mesh.h index e73c03bfafe..a3c588ce813 100644 --- a/Surface_mesher/include/CGAL/IO/facets_in_complex_2_to_triangle_mesh.h +++ b/Surface_mesher/include/CGAL/IO/facets_in_complex_2_to_triangle_mesh.h @@ -32,15 +32,15 @@ namespace CGAL{ \brief Converts a manifold surface reconstructed by `make_surface_mesh()` to a `TriangleMesh`. - This variant exports the surface as a `TriangleMesh` and appends it to `graph`. + This function exports the surface as a `TriangleMesh` and appends it to `graph`. It must be manifold. For this purpose, you may call `make_surface_mesh()` with `Manifold_tag` or `Manifold_with_boundary_tag` parameter. - @tparam C2T3 model of the `SurfaceMeshComplex_2InTriangulation_3` concept. + @tparam C2T3 a model of `SurfaceMeshComplex_2InTriangulation_3`. @tparam TriangleMesh a model of `MutableFaceGraph`. - @param c2t3 an instance of a manifold `C2T3`. + @param c2t3 a manifold instance of `C2T3`. @param graph an instance of `TriangleMesh`. \sa `CGAL::output_surface_facets_to_off()` diff --git a/Surface_mesher/include/CGAL/IO/output_surface_facets_to_polyhedron.h b/Surface_mesher/include/CGAL/IO/output_surface_facets_to_polyhedron.h index 8df995fe884..027532217d3 100644 --- a/Surface_mesher/include/CGAL/IO/output_surface_facets_to_polyhedron.h +++ b/Surface_mesher/include/CGAL/IO/output_surface_facets_to_polyhedron.h @@ -30,10 +30,7 @@ namespace CGAL { -/// \deprecated This function is deprecated since \cgal 4.12, the function -/// `facets_in_complex_2_to_triangle_mesh()` should be used instead. -/// -/// Gets reconstructed surface out of a SurfaceMeshComplex_2InTriangulation_3 object. +/// \deprecated Gets reconstructed surface out of a SurfaceMeshComplex_2InTriangulation_3 object. /// /// This variant exports the surface as a polyhedron. /// It requires the surface to be manifold. For this purpose,