songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

WIP Doc Stream_support

This commit is contained in:
Maxime Gimeno 2020-05-13 12:50:41 +02:00
parent 640f34c975
commit 07f02fe382
5 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Stream_support/doc/Stream_support/Doxyfile.in
View File

@ -1,8 +1,11 @@
@INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS} @INCLUDE = ${CGAL_DOC_PACKAGE_DEFAULTS}
PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - IO Streams" PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - IO Streams"
EXAMPLE_PATH = ${CGAL_PACKAGE_DIR}/examples EXAMPLE_PATH = ${CGAL_PACKAGE_DIR}/examples
INPUT = ${CGAL_BGL_DOC_DIR}/CGAL/boost/graph/IO/STL.h
EXTRACT_ALL = false EXTRACT_ALL = false
HIDE_UNDOC_MEMBERS = true HIDE_UNDOC_MEMBERS = true
HIDE_UNDOC_CLASSES = true HIDE_UNDOC_CLASSES = true

6
Stream_support/doc/Stream_support/PackageDescription.txt
View File

@ -3,6 +3,8 @@
/// \ingroup PkgStreamSupportRef /// \ingroup PkgStreamSupportRef
/// \defgroup IOstreamFunctions I/O Functions /// \defgroup IOstreamFunctions I/O Functions
/// \ingroup PkgStreamSupportRef /// \ingroup PkgStreamSupportRef
/// \defgroup PkgStreamSupportEnumRef I/O Enums
/// \ingroup PkgStreamSupportRef
/*! /*!
\addtogroup PkgStreamSupportRef \addtogroup PkgStreamSupportRef
\cgalPkgDescriptionBegin{IO Streams,PkgStreamSupport} \cgalPkgDescriptionBegin{IO Streams,PkgStreamSupport}
@ -45,7 +47,7 @@ the printing mode.
- `CGAL::oformat()` - `CGAL::oformat()`
\cgalCRPSection{File I/O Functions} \cgalCRPSection{File I/O Functions}
- `CGAL::read_STL()` - \ref CGAL::read_STL()
- `CGAL::write_STL()` - `CGAL::write_STL()`
- `CGAL::read_PLY()` - `CGAL::read_PLY()`
- `CGAL::write_PLY()` - `CGAL::write_PLY()`
@ -54,6 +56,7 @@ the printing mode.
- `CGAL::write_OFF()` - `CGAL::write_OFF()`
- `CGAL::read_VTK()` - `CGAL::read_VTK()`
- `CGAL::write_VTK()` - `CGAL::write_VTK()`
- `GCAL::read_WKT()`
- `CGAL::read_point_WKT()` - `CGAL::read_point_WKT()`
- `GCAL::read_multi_point_WKT()` - `GCAL::read_multi_point_WKT()`
@ -61,7 +64,6 @@ the printing mode.
- `GCAL::read_multi_linestring_WKT()` - `GCAL::read_multi_linestring_WKT()`
- `GCAL::read_polygon_WKT()` - `GCAL::read_polygon_WKT()`
- `GCAL::read_multi_polygon_WKT()` - `GCAL::read_multi_polygon_WKT()`
- `GCAL::read_WKT()`
- `CGAL::write_point_WKT()` - `CGAL::write_point_WKT()`
- `CGAL::write_polygon_WKT()` - `CGAL::write_polygon_WKT()`
- `CGAL::write_linestring_WKT()` - `CGAL::write_linestring_WKT()`

1
Stream_support/include/CGAL/IO/STL.h
View File

@ -25,7 +25,6 @@
#include <iostream> #include <iostream>
namespace CGAL { namespace CGAL {
//////////////////////////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////////////////////////
/// Read /// Read

2
Stream_support/include/CGAL/IO/WKT.h
View File

@ -526,7 +526,7 @@ std::ostream& write_multi_linestring_WKT(std::ostream& out,
return out; return out;
} }
//! \ingroup PkgStreamSupportRef //! \ingroup IOstreamFunctions
//! //!
//! reads the content of a WKT stream and fills //! reads the content of a WKT stream and fills
//! `points`, `polylines` and `polygons` with all the POINT, MULTIPOINT, //! `points`, `polylines` and `polygons` with all the POINT, MULTIPOINT,

2
Stream_support/include/CGAL/IO/io.h
View File

@ -47,7 +47,7 @@ public:
}; };
/*! /*!
\ingroup PkgStreamSupportRef \ingroup PkgStreamSupportEnumRef
All classes in the \cgal `Kernel` provide input and output operators for All classes in the \cgal `Kernel` provide input and output operators for
IOStreams. The basic task of such an operator is to produce a IOStreams. The basic task of such an operator is to produce a