From 28b50b0c5d627a1919a482a3f0d133d140dcd513 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 22 Jun 2020 13:45:29 +0200 Subject: [PATCH] General IO doc improvements --- BGL/include/CGAL/boost/graph/IO/3MF.h | 2 ++ BGL/include/CGAL/boost/graph/IO/GOCAD.h | 8 +++---- BGL/include/CGAL/boost/graph/IO/OBJ.h | 8 +++---- BGL/include/CGAL/boost/graph/IO/OFF.h | 8 +++---- BGL/include/CGAL/boost/graph/IO/PLY.h | 8 +++---- BGL/include/CGAL/boost/graph/IO/STL.h | 8 +++---- BGL/include/CGAL/boost/graph/IO/WRL.h | 2 +- Point_set_3/include/CGAL/Point_set_3/IO/LAS.h | 8 +++---- Point_set_3/include/CGAL/Point_set_3/IO/OFF.h | 18 ++++----------- Point_set_3/include/CGAL/Point_set_3/IO/PLY.h | 13 ++++------- Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h | 16 ++++--------- .../include/CGAL/IO/read_las_points.h | 12 ++++++++-- .../include/CGAL/IO/read_off_points.h | 10 ++++++-- .../include/CGAL/IO/read_ply_points.h | 19 ++++++++++----- .../include/CGAL/IO/read_xyz_points.h | 10 ++++++-- .../include/CGAL/IO/write_las_points.h | 14 +++++++---- .../include/CGAL/IO/write_off_points.h | 12 ++++++++-- .../include/CGAL/IO/write_ply_points.h | 23 +++++++++++-------- .../include/CGAL/IO/write_xyz_points.h | 9 ++++++-- .../doc/Surface_mesh/PackageDescription.txt | 2 -- 20 files changed, 120 insertions(+), 90 deletions(-) diff --git a/BGL/include/CGAL/boost/graph/IO/3MF.h b/BGL/include/CGAL/boost/graph/IO/3MF.h index cf485162126..bd1c3abd418 100644 --- a/BGL/include/CGAL/boost/graph/IO/3MF.h +++ b/BGL/include/CGAL/boost/graph/IO/3MF.h @@ -47,6 +47,8 @@ namespace CGAL { * will appear in the output. * * \return `true` if the writing is successful, `false` otherwise. + * + * \sa `read_3MF()` */ template bool write_3MF(const std::string& filename, diff --git a/BGL/include/CGAL/boost/graph/IO/GOCAD.h b/BGL/include/CGAL/boost/graph/IO/GOCAD.h index 499538f62af..fbee5770873 100644 --- a/BGL/include/CGAL/boost/graph/IO/GOCAD.h +++ b/BGL/include/CGAL/boost/graph/IO/GOCAD.h @@ -82,7 +82,7 @@ public: /// \ingroup PkgBGLIOFct /// -/// \brief Reads the graph `g` from the input stream in the \ref IOStreamGocad. +/// \brief Reads the graph `g` from the input stream, using the \ref IOStreamGocad. /// /// \attention The graph `g` is not cleared, and the data from the stream is added. /// @@ -146,7 +146,7 @@ bool read_GOCAD(std::istream& is, std::pair& name_and_ /// \ingroup PkgBGLIOFct /// -/// \brief Reads the graph `g` from the file `fname` in the \ref IOStreamGocad. +/// \brief Reads the graph `g` from the file `fname`, using the \ref IOStreamGocad. /// /// \attention The graph `g` is not cleared, and the data from the stream is added. /// @@ -212,7 +212,7 @@ bool read_GOCAD(const std::string& fname, Graph& g) { return read_GOCAD(fname, g /// \ingroup PkgBGLIOFct /// -/// \brief Writes the graph `g` in the \ref IOStreamGocad into `os`. +/// \brief Writes the graph `g` into the output stream `os`, using the \ref IOStreamGocad. /// /// \tparam Graph a model of `FaceListGraph` /// \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -309,7 +309,7 @@ bool write_GOCAD(std::ostream& os, const char* name, const Graph& g) /// \ingroup PkgBGLIOFct /// -/// \brief Writes the graph `g` in the \ref IOStreamGocad into a file named `fname`. +/// \brief Writes the graph `g` into a file named `fname`, using the \ref IOStreamGocad. /// /// In this overload, `fname` is used as the name of the graph within the file. /// diff --git a/BGL/include/CGAL/boost/graph/IO/OBJ.h b/BGL/include/CGAL/boost/graph/IO/OBJ.h index bc133147c3a..67ca378c009 100644 --- a/BGL/include/CGAL/boost/graph/IO/OBJ.h +++ b/BGL/include/CGAL/boost/graph/IO/OBJ.h @@ -74,7 +74,7 @@ public: /*! \ingroup PkgBGLIOFct - \brief Reads the graph `g` from the stream `in` in the \ref IOStreamOBJ. + \brief Reads the graph `g` from the stream `in`, using the \ref IOStreamOBJ. Ignores comment lines which start with a hash, and lines with whitespace. @@ -122,7 +122,7 @@ bool read_OBJ(std::istream& is, /*! \ingroup PkgBGLIOFct - \brief Reads the graph `g` from data in the \ref IOStreamOBJ. + \brief Reads the graph `g` from the file `fname`, using the \ref IOStreamOBJ. Ignores comment lines which start with a hash, and lines with whitespace. @@ -187,7 +187,7 @@ bool read_OBJ(const std::string& fname, Graph& g) { return read_OBJ(fname, g, pa /*! \ingroup PkgBGLIOFct - \brief Writes the graph `g` in the \ref IOStreamOBJ. + \brief Writes the graph `g` into the output stream, using the \ref IOStreamOBJ. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -230,7 +230,7 @@ bool write_OBJ(std::ostream& os, /*! \ingroup PkgBGLIOFct - \brief Writes the graph `g` in the \ref IOStreamOBJ into a file named `fname`. + \brief Writes the graph `g` into a file named `fname`, using the \ref IOStreamOBJ. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/OFF.h b/BGL/include/CGAL/boost/graph/IO/OFF.h index 4dd2411d382..92cbcd1fffe 100644 --- a/BGL/include/CGAL/boost/graph/IO/OFF.h +++ b/BGL/include/CGAL/boost/graph/IO/OFF.h @@ -88,7 +88,7 @@ bool read_OFF_BGL(std::istream& is, /*! \ingroup PkgBGLIOFct - \brief Reads the graph `g` from data in the \ref IOStreamOFF. + \brief Reads the graph `g` from data in the input stream, using the \ref IOStreamOFF. Ignores comment lines which start with a hash, and lines with whitespace. @@ -171,7 +171,7 @@ bool read_OFF(std::istream& is, Graph& g, /*! \ingroup PkgBGLIOFct - \brief Reads the graph `g` from `fname`, a file in the \ref IOStreamOFF. + \brief Reads the graph `g` from the file `fname`, using the \ref IOStreamOFF. Ignores comment lines which start with a hash, and lines with whitespace. @@ -288,7 +288,7 @@ bool write_OFF_BGL(std::ostream& os, /*! \ingroup PkgBGLIOFct - \brief Writes the graph `g` in the \ref IOStreamOFF. + \brief Writes the graph `g` in the output stream, using the \ref IOStreamOFF. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -369,7 +369,7 @@ bool write_OFF(std::ostream& os, const Graph& g, /*! \ingroup PkgBGLIOFct - \brief Writes the graph `g` in the file `fname`, in the \ref IOStreamOFF. + \brief Writes the graph `g` in the file `fname`, using the \ref IOStreamOFF. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/PLY.h b/BGL/include/CGAL/boost/graph/IO/PLY.h index 77cbbae0494..029c05cbe71 100644 --- a/BGL/include/CGAL/boost/graph/IO/PLY.h +++ b/BGL/include/CGAL/boost/graph/IO/PLY.h @@ -83,7 +83,7 @@ bool read_PLY_BGL(std::istream& is, /*! \ingroup PkgBGLIOFct - \brief Reads the graph `g` from data in the \ref IOStreamPLY. + \brief Reads the graph `g` from the input stream, using the \ref IOStreamPLY. \tparam Graph a model of `MutableFaceGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -153,7 +153,7 @@ bool read_PLY(std::istream& is, Graph& g, /*! \ingroup PkgBGLIOFct - \brief Reads the graph `g` from a file named `fname`, in the \ref IOStreamPLY. + \brief Reads the graph `g` from a file named `fname`, using the \ref IOStreamPLY. \tparam Graph a model of `MutableFaceGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -244,7 +244,7 @@ bool read_PLY(const std::string& fname, Graph& g, /*! \ingroup PkgBGLIOFct - \brief Writes the graph in an output stream in \ref IOStreamPLY. + \brief Writes the graph in an output stream, using the \ref IOStreamPLY. \tparam Graph a model of `FaceListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -442,7 +442,7 @@ bool write_PLY(std::ostream& os, const Graph& g, /*! \ingroup PkgBGLIOFct - \brief Writes the graph in the output file `fname` in the \ref IOStreamPLY. + \brief Writes the graph in the output file `fname`, using the \ref IOStreamPLY. \tparam Graph a model of `FaceListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/STL.h b/BGL/include/CGAL/boost/graph/IO/STL.h index a67258c7b33..eddbbc738c4 100644 --- a/BGL/include/CGAL/boost/graph/IO/STL.h +++ b/BGL/include/CGAL/boost/graph/IO/STL.h @@ -69,7 +69,7 @@ public: /*! \ingroup PkgBGLIOFct - \brief Reads the graph `g` from data in the \ref IOStreamSTL. + \brief Reads the graph `g` from the input stream, using the \ref IOStreamSTL. \attention The graph `g` is not cleared, and the data from the stream is added. @@ -114,7 +114,7 @@ bool read_STL(std::istream& is, /*! \ingroup PkgBGLIOFct - \brief Reads the graph `g` from the file `fname` in the \ref IOStreamSTL. + \brief Reads the graph `g` from the file `fname`, using the \ref IOStreamSTL. \attention The graph `g` is not cleared, and the data from the stream is added. @@ -172,7 +172,7 @@ bool read_STL(const std::string& fname, Graph& g) { return read_STL(fname, g, pa /*! \ingroup PkgBGLIOFct - \brief Writes the graph `g` in the stream `os` in the \ref IOStreamSTL. + \brief Writes the graph `g` in the output stream `os`, using the \ref IOStreamSTL. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" @@ -280,7 +280,7 @@ bool write_STL(std::ostream& os, /*! \ingroup PkgBGLIOFct - \brief Writes the graph `g` in the \ref IOStreamSTL into a file named `fname`. + \brief Writes the graph `g` into a file named `fname`, using the \ref IOStreamSTL. \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/BGL/include/CGAL/boost/graph/IO/WRL.h b/BGL/include/CGAL/boost/graph/IO/WRL.h index ba8329f23dc..8bd82448a5f 100644 --- a/BGL/include/CGAL/boost/graph/IO/WRL.h +++ b/BGL/include/CGAL/boost/graph/IO/WRL.h @@ -31,7 +31,7 @@ namespace CGAL { /*! \ingroup PkgBGLIOFct - \brief Writes the graph `g` in the \ref IOStreamWRL (VRML 2.0). + \brief Writes the graph `g` into the output stream, using the \ref IOStreamWRL (VRML 2.0). \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph` \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h b/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h index 87b9c1b6c4c..011463803a8 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h @@ -60,7 +60,7 @@ void check_if_property_is_used(PointSet& point_set, /*! \ingroup PkgPointSet3IO - \brief Reads the content of an intput stream in the LAS format into a point set. + \brief Reads the content of an intput stream in the \ref IOStreamLAS into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -154,7 +154,7 @@ bool read_LAS(std::istream& is, /*! \ingroup PkgPointSet3IO - \brief Reads the content of an intput stream in the LAS format into a point set. + \brief Reads the content of an intput stream in the \ref IOStreamLAS into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -201,7 +201,7 @@ CGAL_DEPRECATED bool read_las_point_set(std::istream& is, ///< input stream. /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output stream in the LAS format. + \brief Writes the content of a point set into an output stream in the \ref IOStreamLAS. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -404,7 +404,7 @@ bool write_LAS(std::ostream& os, CGAL::Point_set_3& point_set) /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output file in the LAS format. + \brief Writes the content of a point set into an output file in the \ref IOStreamLAS. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h b/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h index cd6cc4710b1..1129bb971ba 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h @@ -41,7 +41,7 @@ class Point_set_3; /*! \ingroup PkgPointSet3IO - \brief Reads the content of an intput stream in the OFF format into a point set. + \brief Reads the content of an intput stream in the \ref IOStreamOFF into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -50,8 +50,6 @@ class Point_set_3; \param point_set the point set \return `true` if the reading was successful, `false` otherwise. - - \see \ref IOStreamOFF */ template bool read_OFF(std::istream& is, @@ -82,7 +80,7 @@ bool read_OFF(std::istream& is, /*! \ingroup PkgPointSet3IO - \brief Reads the content of an input OFF file in a point set. + \brief Reads the content of an input file in the \ref IOStreamOFF into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -91,8 +89,6 @@ bool read_OFF(std::istream& is, \param point_set the point set \return `true` if the reading was successful, `false` otherwise. - - \see \ref IOStreamOFF */ template bool read_OFF(const char* fname, CGAL::Point_set_3& point_set) @@ -131,7 +127,7 @@ CGAL_DEPRECATED bool read_off_point_set(std::istream& is, ///< input stream. /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output stream in the OFF format. + \brief Writes the content of a point set into an output stream in the \ref IOStreamOFF. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -150,8 +146,6 @@ CGAL_DEPRECATED bool read_off_point_set(std::istream& is, ///< input stream. \cgalNamedParamsEnd \return `true` if the writing was successful, `false` otherwise. - - \see \ref IOStreamOFF */ template bool write_OFF(std::ostream& os, @@ -176,7 +170,7 @@ bool write_OFF(std::ostream& os, const CGAL::Point_set_3& point_s /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output file in the OFF format. + \brief Writes the content of a point set into an output file in the \ref IOStreamOFF. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -195,9 +189,7 @@ bool write_OFF(std::ostream& os, const CGAL::Point_set_3& point_s \cgalNamedParamsEnd \return `true` if the writing was successful, `false` otherwise. - - \see \ref IOStreamOFF - */ +*/ template bool write_OFF(const char* fname, const CGAL::Point_set_3& point_set, const CGAL_BGL_NP_CLASS& np) { diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h b/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h index c8c45aa3c0d..0675dc3b6ec 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h @@ -224,7 +224,7 @@ public: /*! \ingroup PkgPointSet3IO - \brief Reads a point set with properties from an input stream in ASCII or Binary PLY format. + \brief Reads a point set with properties from an input stream in ASCII or Binary \ref IOStreamPLY. - the operator reads the vertex `point` property; - if three PLY properties `nx`, `ny` and `nz` with type `float` @@ -245,8 +245,6 @@ public: \param comments optional PLY comments. \return `true` if the reading was successful, `false` otherwise. - - \see \ref IOStreamPLY */ template bool read_PLY(std::istream& is, @@ -302,7 +300,7 @@ bool read_PLY(std::istream& is, /*! \ingroup PkgPointSet3IO - \brief Reads a point set with properties from an input stream in ASCII or Binary PLY format. + \brief Reads a point set with properties from an input stream in ASCII or Binary \ref IOStreamPLY. - the operator reads the vertex `point` property; - if three PLY properties `nx`, `ny` and `nz` with type `float` @@ -323,8 +321,6 @@ bool read_PLY(std::istream& is, \param comments optional PLY comments. \return `true` if the reading was successful, `false` otherwise. - - \see \ref IOStreamPLY */ template bool read_PLY(const char* fname, CGAL::Point_set_3& point_set, const std::string& comments) @@ -398,7 +394,7 @@ CGAL_DEPRECATED bool read_ply_point_set(std::istream& is, ///< input stream. /*! \ingroup PkgPointSet3IO - \brief Writes a point set with properties in an output stream in PLY format. + \brief Writes a point set with properties in an output stream in the \ref IOStreamPLY. If found, the normal map is inserted to the stream. All other properties with simple types are inserted in the stream. @@ -664,7 +660,7 @@ bool write_PLY(std::ostream& os, const CGAL::Point_set_3& point_s /*! \ingroup PkgPointSet3IO - \brief Writes a point set with properties in an output stream in PLY format. + \brief Writes a point set with properties in an output stream in the \ref IOStreamPLY. If found, the normal map is inserted to the stream. All other properties with simple types are inserted in the stream. @@ -691,7 +687,6 @@ bool write_PLY(std::ostream& os, const CGAL::Point_set_3& point_s \cgalNamedParamsEnd \return `true` if the reading was successful, `false` otherwise. - \see \ref IOStreamPLY */ template bool write_PLY(const char* fname, const CGAL::Point_set_3& point_set, diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h b/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h index 319c658c617..aa6c4b857e1 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h @@ -40,7 +40,7 @@ class Point_set_3; /*! \ingroup PkgPointSet3IO - \brief Reads the content of an intput stream in the XYZ format into a point set. + \brief Reads the content of an intput stream in the \ref IOStreamXYZ into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -49,8 +49,6 @@ class Point_set_3; \param point_set the point set \return `true` if the reading was successful, `false` otherwise. - - \see \ref IOStreamXYZ */ template bool read_XYZ(std::istream& is, @@ -81,7 +79,7 @@ bool read_XYZ(std::istream& is, /*! \ingroup PkgPointSet3IO - \brief Reads the content of an input XYZ file in a point set. + \brief Reads the content of an input file in the the \ref IOStreamXYZ into a point set. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -90,8 +88,6 @@ bool read_XYZ(std::istream& is, \param point_set the point set \return `true` if the reading was successful, `false` otherwise. - - \see \ref IOStreamXYZ */ template bool read_XYZ(const char* fname, CGAL::Point_set_3& point_set) @@ -129,7 +125,7 @@ CGAL_DEPRECATED bool read_xyz_point_set(std::istream& is, CGAL::Point_set_3 bool write_XYZ(std::ostream& os, @@ -173,7 +167,7 @@ bool write_XYZ(std::ostream& os, const CGAL::Point_set_3& point_s /*! \ingroup PkgPointSet3IO - \brief Writes the content of a point set into an output file in the XYZ format. + \brief Writes the content of a point set into an output file in the \ref IOStreamXYZ. \tparam Point a `CGAL::Point_3` \tparam Vector a `CGAL::Vector_3` @@ -192,8 +186,6 @@ bool write_XYZ(std::ostream& os, const CGAL::Point_set_3& point_s \cgalNamedParamsEnd \return `true` if the writing was successful, `false` otherwise. - - \see \ref IOStreamXYZ */ template bool write_XYZ(const char* fname, const CGAL::Point_set_3& point_set, const CGAL_BGL_NP_CLASS& np) diff --git a/Point_set_processing_3/include/CGAL/IO/read_las_points.h b/Point_set_processing_3/include/CGAL/IO/read_las_points.h index 9449e227374..4ea66b480a1 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_las_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_las_points.h @@ -134,6 +134,7 @@ typedef Base I; \tparam PointMap the property map used to store points. \sa `read_LAS_with_properties()` + \sa \ref IOStreamLAS */ template std::tuple bool read_LAS(const char* fname, OutputIterator output, const CGAL_BGL_NP_CLASS& np) diff --git a/Point_set_processing_3/include/CGAL/IO/read_off_points.h b/Point_set_processing_3/include/CGAL/IO/read_off_points.h index 0361c026c05..4f663522128 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_off_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_off_points.h @@ -42,7 +42,8 @@ namespace CGAL { /** \ingroup PkgPointSetProcessing3IOOff - Reads points (positions + normals, if available) from a .off ASCII stream. + \brief Reads points (positions + normals, if available) from a .off ASCII stream. + The function expects for each point a line with the x y z position, optionally followed by the nx ny nz normal. Faces are ignored. @@ -77,6 +78,8 @@ namespace CGAL { \cgalNamedParamsEnd \return `true` on success. + + \sa \ref IOStreamOFF */ template std::tuple std::tuple std::tuple @@ -180,6 +181,7 @@ namespace LAS { \return `true` on success. \sa `make_las_point_writer()` + \sa \ref IOStreamLAS */ template bool write_LAS(std::ostream& os, @@ -338,6 +342,8 @@ bool write_LAS(std::ostream& os, \cgalNamedParamsEnd \return `true` on success. + + \sa \ref IOStreamLAS */ template bool write_LAS(const char* filename, diff --git a/Point_set_processing_3/include/CGAL/IO/write_off_points.h b/Point_set_processing_3/include/CGAL/IO/write_off_points.h index 16d1e6f07bc..02137e47350 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_off_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_off_points.h @@ -90,7 +90,9 @@ bool write_OFF_PSP(std::ostream& os, /** \ingroup PkgPointSetProcessing3IOOff - Saves the range of `points` (positions + normals, if available) to a .off ASCII stream. + + \brief Saves the range of `points` (positions + normals, if available) to a .off ASCII stream. + The function writes for each point a line with the x y z position followed by the nx ny nz normal (if available). @@ -132,6 +134,8 @@ bool write_OFF_PSP(std::ostream& os, \cgalNamedParamsEnd \return `true` on success. + + \sa \ref IOStreamOFF */ template bool write_OFF(std::ostream& os, @@ -154,7 +158,9 @@ bool write_OFF(std::ostream& os, const PointRange& points, /** \ingroup PkgPointSetProcessing3IOOff - Saves the range of `points` (positions + normals, if available) to a .off ASCII stream. + + \brief Saves the range of `points` (positions + normals, if available) to a .off ASCII stream. + The function writes for each point a line with the x y z position followed by the nx ny nz normal (if available). @@ -196,6 +202,8 @@ bool write_OFF(std::ostream& os, const PointRange& points, \cgalNamedParamsEnd \return `true` on success. + + \sa \ref IOStreamOFF */ template diff --git a/Point_set_processing_3/include/CGAL/IO/write_ply_points.h b/Point_set_processing_3/include/CGAL/IO/write_ply_points.h index 6cdef097f32..45ddb4a8088 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_ply_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_ply_points.h @@ -51,6 +51,7 @@ namespace CGAL { \tparam PointMap the property map used to store points. \sa `write_PLY_with_properties()` + \sa \ref IOStreamPLY */ template std::tuple, PLY_property, PLY_property > @@ -67,6 +68,7 @@ namespace CGAL { \tparam VectorMap the property map used to store vectors. \sa `write_PLY_with_properties()` + \sa \ref IOStreamPLY */ template std::tuple, PLY_property, PLY_property > @@ -76,9 +78,9 @@ namespace CGAL { /** \ingroup PkgPointSetProcessing3IOPly - Saves the range of `points` with properties to a - .ply stream. %PLY is either ASCII or binary depending on the value - of `CGAL::get_mode(os)`. + \brief Saves the range of `points` with properties to a .ply stream. + + %PLY is either ASCII or binary depending on the value of `CGAL::get_mode(os)`. Properties are handled through a variadic list of property handlers. A `PropertyHandler` can either be: @@ -100,6 +102,7 @@ namespace CGAL { \return `true` on success. + \sa \ref IOStreamPLY \sa `make_ply_point_writer()` \sa `make_ply_normal_writer()` */ @@ -137,9 +140,9 @@ template bool write_PLY(const char* filename, diff --git a/Point_set_processing_3/include/CGAL/IO/write_xyz_points.h b/Point_set_processing_3/include/CGAL/IO/write_xyz_points.h index 120dbd8a91b..746e2393094 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_xyz_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_xyz_points.h @@ -87,7 +87,7 @@ bool write_XYZ_PSP(std::ostream& os, /** \ingroup PkgPointSetProcessing3IOXyz - Saves the range of `points` (positions + normals, if available) to a .xyz ASCII stream. + \brief Saves the range of `points` (positions + normals, if available) to a .xyz ASCII stream. The function writes for each point a line with the x y z position followed by the nx ny nz normal (if available). @@ -126,6 +126,8 @@ bool write_XYZ_PSP(std::ostream& os, \cgalNamedParamsEnd \return `true` on success. + + \sa \ref IOStreamXYZ */ template bool write_XYZ(std::ostream& os, @@ -149,7 +151,8 @@ bool write_XYZ(std::ostream& os, const PointRange& points, /** \ingroup PkgPointSetProcessing3IOXyz - Saves the range of `points` (positions + normals, if available) to a .xyz ASCII stream. + \brief Saves the range of `points` (positions + normals, if available) to a .xyz ASCII stream. + The function writes for each point a line with the x y z position followed by the nx ny nz normal (if available). @@ -188,6 +191,8 @@ bool write_XYZ(std::ostream& os, const PointRange& points, \cgalNamedParamsEnd \return `true` on success. + + \sa \ref IOStreamXYZ */ template bool write_XYZ(const char* filename, diff --git a/Surface_mesh/doc/Surface_mesh/PackageDescription.txt b/Surface_mesh/doc/Surface_mesh/PackageDescription.txt index 77fea89c804..18231d54b57 100644 --- a/Surface_mesh/doc/Surface_mesh/PackageDescription.txt +++ b/Surface_mesh/doc/Surface_mesh/PackageDescription.txt @@ -34,8 +34,6 @@ and faces is much simpler and can be used at runtime and not at compile time.} \cgalClassifedRefPages - - \cgalCRPSection{Classes} - `CGAL::Surface_mesh

`