From f0b0981e8bb1181c963f236ecd33b6d11fc580e3 Mon Sep 17 00:00:00 2001 From: Maxime Gimeno Date: Tue, 30 Oct 2018 14:52:05 +0100 Subject: [PATCH] add missing functions to concepts --- .../doc/Stream_support/CGAL/IO/io.h | 67 ++++++++++++++++--- 1 file changed, 56 insertions(+), 11 deletions(-) diff --git a/Stream_support/doc/Stream_support/CGAL/IO/io.h b/Stream_support/doc/Stream_support/CGAL/IO/io.h index 7624f30117c..746e993236b 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/io.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/io.h @@ -309,7 +309,12 @@ read_point_WKT( std::istream& in, //! with the first line starting with MULTIPOINT in the stream. //! //! \tparam MultiPoint must be a model of `RandomAccessRange` of `CGAL::Point_2` or `CGAL::Point_3`, -//! and have a function `push_back()` that takes the same point type. +//! and have: +//! - a function `push_back()` that takes the same point type, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. +//! //! \attention Only Cartesian Kernels are supported. //! //! \see `CGAL::Point_2` @@ -325,7 +330,11 @@ read_multi_point_WKT( std::istream& in, //! The first line starting with LINESTRING in the stream will be used. //! //! \tparam Linestring must be a model of `RandomAccessRange` of `CGAL::Point_2`, -//! and have a function `push_back()` that takes a `CGAL::Point_2`. +//! and have: +//! - a function `push_back()` that takes a `CGAL::Point_2`. +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \attention Only Cartesian Kernels are supported. //! \see `CGAL::Point_2` template @@ -338,7 +347,11 @@ read_linestring_WKT( std::istream& in, //! with the first line starting with MULTILINESTRING in the stream. //! //! \tparam MultiLineString must be a model of `RandomAccessRange` of `Linestring`, -//! and have a function `push_back()` that takes a `Linestring`. +//! and have: +//! - a function `push_back()` that takes a `Linestring`, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \attention Only Cartesian Kernels are supported. //! //! \see `CGAL::Point_2` @@ -365,7 +378,11 @@ read_polygon_WKT( std::istream& in, //! with the first line starting with MULTIPOLYGON in the stream. //! //! \tparam Multipolygon must be a model of `RandomAccessRange` of `CGAL::General_polygon_with_holes_2`, -//! and have a function `push_back()` that takes a `CGAL::General_polygon_with_holes_2`. +//! and have: +//! - a function `push_back()` that takes a `CGAL::General_polygon_with_holes_2`, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \attention Only Cartesian Kernels are supported. //! \see `CGAL::General_polygon_with_holes_2` @@ -398,7 +415,11 @@ write_polygon_WKT( std::ostream& out, //! \brief `write_linestring_WKT()` writes the content of `ls` //! into a WKT stream. //! \tparam LineString must be a `RandomAccessRange` of `CGAL::Point_2`, -//! and have a function `push_back()` that takes a `CGAL::Point_2`. +//! and have: +//! - a function `push_back()` that takes a `CGAL::Point_2`, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \attention Only Cartesian Kernels are supported. //!\see `CGAL::Point_2` template @@ -410,7 +431,11 @@ write_linestring_WKT( std::ostream& out, //! \brief `write_multi_point_WKT()` writes the content of `mp` //! into a WKT stream. //! \tparam MultiPoint must be a `RandomAccessRange` of `CGAL::Point_2`, -//! and have a function `push_back()` that takes a `CGAL::Point_2`. +//! and have: +//! - a function `push_back()` that takes a `CGAL::Point_2`, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \attention Only Cartesian Kernels are supported. //!\see `CGAL::Point_2` template @@ -422,7 +447,11 @@ write_multi_point_WKT( std::ostream& out, //! \brief `write_multi_polygon_WKT()` writes the content of `polygons` //! into a WKT stream. //! \tparam MultiPolygon must be a `RandomAccessRange` of `CGAL::General_polygon_with_holes_2`, -//! and have a function `push_back()` that takes a `CGAL::General_polygon_with_holes_2`. +//! and have: +//! - a function `push_back()` that takes a `CGAL::General_polygon_with_holes_2`, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \attention Only Cartesian Kernels are supported. //!\see `CGAL::General_polygon_with_holes_2` template @@ -434,7 +463,11 @@ write_multi_polygon_WKT( std::ostream& out, //! \brief `write_multi_linestring_WKT()` writes the content of `mls` //! into a WKT stream. //! \tparam MultiLineString must be a `RandomAccessRange` of `LineString`, -//! and have a function `push_back()` that takes a `Linestring`. +//! and have: +//! - a function `push_back()` that takes a `Linestring`, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \attention Only Cartesian Kernels are supported. //! \see `CGAL::write_linestring_WKT()` template @@ -447,11 +480,23 @@ write_multi_linestring_WKT( std::ostream& out, //! `points`, `polylines` and `polygons` with all the POINT, MULTIPOINT, //! LINESTRING, MULTILINESTRING, POLYGON and MULTIPOLYGON it finds in `input`. //! \tparam MultiPoint must be a model of `RandomAccessRange` of `CGAL::Point_2` or `CGAL::Point_3`, -//! and have a function `push_back()` that takes the same point type. +//! and have: +//! - a function `push_back()` that takes the same point type, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \tparam MultiLineString must be a `RandomAccessRange` of `Linestring`, -//! and have a function `push_back()` that takes a `Linestring`. +//! and have: +//! - a function `push_back()` that takes a `Linestring`, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \tparam MultiPolygon must be a model of `RandomAccessRange` of `CGAL::General_polygon_with_holes_2`, -//! and have a function `push_back()` that takes a `CGAL::General_polygon_with_holes_2`. +//! and have: +//! - a function `push_back()` that takes a `CGAL::General_polygon_with_holes_2`, +//! - a function `clear()`, +//! - a function `resize()` that takes an `size_type` +//! - an `operator[]()` that takes a `size_type`. //! \attention Only Cartesian Kernels are supported. //! \see `CGAL::read_linestring_WKT()` template