From 07f02fe38241947789806c36bf24bfe9cf30cf75 Mon Sep 17 00:00:00 2001 From: Maxime Gimeno Date: Wed, 13 May 2020 12:50:41 +0200 Subject: [PATCH] WIP Doc Stream_support --- Stream_support/doc/Stream_support/Doxyfile.in | 3 +++ Stream_support/doc/Stream_support/PackageDescription.txt | 6 ++++-- Stream_support/include/CGAL/IO/STL.h | 1 - Stream_support/include/CGAL/IO/WKT.h | 2 +- Stream_support/include/CGAL/IO/io.h | 2 +- 5 files changed, 9 insertions(+), 5 deletions(-) diff --git a/Stream_support/doc/Stream_support/Doxyfile.in b/Stream_support/doc/Stream_support/Doxyfile.in index a49325a026c..540ea9421e5 100644 --- a/Stream_support/doc/Stream_support/Doxyfile.in +++ b/Stream_support/doc/Stream_support/Doxyfile.in @@ -1,8 +1,11 @@ @INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS} + PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - IO Streams" EXAMPLE_PATH = ${CGAL_PACKAGE_DIR}/examples +INPUT = ${CGAL_BGL_DOC_DIR}/CGAL/boost/graph/IO/STL.h + EXTRACT_ALL = false HIDE_UNDOC_MEMBERS = true HIDE_UNDOC_CLASSES = true diff --git a/Stream_support/doc/Stream_support/PackageDescription.txt b/Stream_support/doc/Stream_support/PackageDescription.txt index 48761b6a5a3..856b89d15f2 100644 --- a/Stream_support/doc/Stream_support/PackageDescription.txt +++ b/Stream_support/doc/Stream_support/PackageDescription.txt @@ -3,6 +3,8 @@ /// \ingroup PkgStreamSupportRef /// \defgroup IOstreamFunctions I/O Functions /// \ingroup PkgStreamSupportRef +/// \defgroup PkgStreamSupportEnumRef I/O Enums +/// \ingroup PkgStreamSupportRef /*! \addtogroup PkgStreamSupportRef \cgalPkgDescriptionBegin{IO Streams,PkgStreamSupport} @@ -45,7 +47,7 @@ the printing mode. - `CGAL::oformat()` \cgalCRPSection{File I/O Functions} -- `CGAL::read_STL()` +- \ref CGAL::read_STL() - `CGAL::write_STL()` - `CGAL::read_PLY()` - `CGAL::write_PLY()` @@ -54,6 +56,7 @@ the printing mode. - `CGAL::write_OFF()` - `CGAL::read_VTK()` - `CGAL::write_VTK()` +- `GCAL::read_WKT()` - `CGAL::read_point_WKT()` - `GCAL::read_multi_point_WKT()` @@ -61,7 +64,6 @@ the printing mode. - `GCAL::read_multi_linestring_WKT()` - `GCAL::read_polygon_WKT()` - `GCAL::read_multi_polygon_WKT()` -- `GCAL::read_WKT()` - `CGAL::write_point_WKT()` - `CGAL::write_polygon_WKT()` - `CGAL::write_linestring_WKT()` diff --git a/Stream_support/include/CGAL/IO/STL.h b/Stream_support/include/CGAL/IO/STL.h index 49b3f1a3c9e..53a05075499 100644 --- a/Stream_support/include/CGAL/IO/STL.h +++ b/Stream_support/include/CGAL/IO/STL.h @@ -25,7 +25,6 @@ #include namespace CGAL { - //////////////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////////////// /// Read diff --git a/Stream_support/include/CGAL/IO/WKT.h b/Stream_support/include/CGAL/IO/WKT.h index 4f085d5cfc5..216f0bd1bff 100644 --- a/Stream_support/include/CGAL/IO/WKT.h +++ b/Stream_support/include/CGAL/IO/WKT.h @@ -526,7 +526,7 @@ std::ostream& write_multi_linestring_WKT(std::ostream& out, return out; } -//! \ingroup PkgStreamSupportRef +//! \ingroup IOstreamFunctions //! //! reads the content of a WKT stream and fills //! `points`, `polylines` and `polygons` with all the POINT, MULTIPOINT, diff --git a/Stream_support/include/CGAL/IO/io.h b/Stream_support/include/CGAL/IO/io.h index f7d177ac50d..5baabd975ba 100644 --- a/Stream_support/include/CGAL/IO/io.h +++ b/Stream_support/include/CGAL/IO/io.h @@ -47,7 +47,7 @@ public: }; /*! -\ingroup PkgStreamSupportRef +\ingroup PkgStreamSupportEnumRef All classes in the \cgal `Kernel` provide input and output operators for IOStreams. The basic task of such an operator is to produce a