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

Add non const iterator in the doc

This commit is contained in:
Andreas Fabri 2023-11-16 07:16:16 +00:00
parent 7ed78a0e15
commit 04264b5e89
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Polygon/doc/Polygon/Concepts/MultipolygonWithHoles_2.h
View File

@ -22,6 +22,11 @@ typedef unspecified_type Polygon_with_holes_2;
/*! a bidirectional iterator over the polygons with holes. /*! a bidirectional iterator over the polygons with holes.
* Its value type is `Polygon_with_holes_2`. * Its value type is `Polygon_with_holes_2`.
*/ */
typedef unspecified_type Polygon_with_holes_iterator;
/*! a bidirectional const iterator over the polygons with holes.
* Its value type is `Polygon_with_holes_2`.
*/
typedef unspecified_type Polygon_with_holes_const_iterator; typedef unspecified_type Polygon_with_holes_const_iterator;
//! range type for iterating over polygons with holes. //! range type for iterating over polygons with holes.
@ -54,6 +59,14 @@ Size number_of_polygons_wih_holes();
/// \name Access Functions /// \name Access Functions
/// @{ /// @{
/*! returns the begin iterator of the polygons with holes.
*/
Polygon_with_holes_iterator polygons_with_holes_begin();
/*! returns the past-the-end iterator of the polygons with holes.
*/
Polygon_with_holes_iterator polygons_with_holes_end();
/*! returns the begin iterator of the polygons with holes. /*! returns the begin iterator of the polygons with holes.
*/ */
Polygon_with_holes_const_iterator polygons_with_holes_begin() const; Polygon_with_holes_const_iterator polygons_with_holes_begin() const;
@ -77,7 +90,7 @@ void add_polygon_with_holes(const Polygon_with_holes_2& polygon);
/*! erases the specified polygon. /*! erases the specified polygon.
*/ */
void erase_polygon_with_holes(Polygon_iterator pit); void erase_polygon_with_holes(Polygon_with_holes_const_iterator pit);
/*! removes all the polygons with holes. /*! removes all the polygons with holes.
*/ */