diff --git a/BGL/include/CGAL/boost/graph/IO/VTK.h b/BGL/include/CGAL/boost/graph/IO/VTK.h index fbfbd64a6a5..2f61fbff1b4 100644 --- a/BGL/include/CGAL/boost/graph/IO/VTK.h +++ b/BGL/include/CGAL/boost/graph/IO/VTK.h @@ -116,6 +116,8 @@ bool vtkPointSet_to_polygon_mesh(vtkPointSet* poly_data, * * \brief reads a PolyData in the \ref IOStreamVTK into a triangulated surface mesh. * + * \attention The graph `g` is not cleared, and the data from the stream is added. + * * \tparam Graph a model of `MutableFaceGraph` * \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" * @@ -138,8 +140,6 @@ bool vtkPointSet_to_polygon_mesh(vtkPointSet* poly_data, * \pre The data must represent a 2-manifold * \pre \cgal needs to be configured with the VTK Libraries for this function to be available. * - * \attention The graph `g` is not cleared, and the data from the stream is added. - * * \returns `true` if reading was successful, `false` otherwise. */ templategeneric I/O function +and an output function called `write_XXX(output, data_structure)`. Whenever possible, a generic I/O function which can deduce the file format from the extension is also provided for convenience. -In the following subsection, file formats supported in \cgal are listed along with associated -potential data structures. A reverse viewpoint, listing the data structures which can be used for a specific file format +In the following subsection, file formats supported in \cgal are listed along with compatible +\cgal data structures. A reverse viewpoint, listing the data structures which can be used for a specific file format is available on the page: \ref IOStreamSupportedFileFormats. Note that these categories will grow as the on-going effort to uniformize I/O in \cgal progresses. @@ -451,7 +451,6 @@ If this is not the case, the package \ref PkgPolygonMeshProcessing offers the fu which can perform some combinatorial repairing to ensure the input data is a 2-manifold. \subsection IOstreamWKT Simple 2D Geometry IO - `WKT` stands for Well-Known Text and it is a text markup language for representing vector geometry objects on a geographical map. See the wikipedia page for details. @@ -492,16 +491,7 @@ from the standard \cgal I/O functions, for clarity reasons. \subsection IOstreamOtherIO Other Data Structures -Other data structures of \cgal have their own I/O functions, detailed in their respective manuals, -for example: - -- \ref AlphaShape3DIO "3D Alpha Shapes" -- \ref arr_secio "2D Arrangements" -- \ref Nef_3File "3D Boolean Operations on Nef Polyhedra" -- \ref secMesh_2_IO "2D Conforming Triangulations and Meshes" -- \ref Mesh_3_section_io "3D Mesh Generation" -- \ref Surface_mesherIO "Surface Mesh Generation" -- ... +Other data structures of \cgal have their own I/O functions, see their respective user and reference manuals. \subsection IOstreamOther Reading Unsupported Formats diff --git a/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h b/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h index 5f2bd1a1120..9661d813982 100644 --- a/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h +++ b/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h @@ -269,7 +269,7 @@ bool read_OFF_with_or_without_vnormals(std::istream& is, /// /// Ignores comment lines which start with a hash, and lines with whitespace. /// -///\attention The graph `g` is not cleared, and the data from the stream is added. +/// \attention The graph `g` is not cleared, and the data from the stream is added. /// /// \tparam Point The type of the \em point property of a vertex. There is no requirement on `P`, /// besides being default constructible and assignable.