Document general polygon funtion returning range of holes

This commit is contained in:
Andreas Fabri 2022-03-03 14:48:28 +00:00
parent 8430d04539
commit 0ff972fbaa
1 changed files with 12 additions and 0 deletions

View File

@ -29,6 +29,12 @@ typedef unspecified_type Polygon_2;
*/ */
typedef unspecified_type Hole_const_iterator; typedef unspecified_type Hole_const_iterator;
/*!
range type for iterating over holes.
*/
typedef unspecified_type Holes_container;
/// @} /// @}
/// \name Creation /// \name Creation
@ -73,6 +79,12 @@ Hole_const_iterator holes_begin() const;
*/ */
Hole_const_iterator holes_end() const; Hole_const_iterator holes_end() const;
/*!
returns the range of holes.
*/
const Holes_container& holes() const;
/// @} /// @}
}; /* end GeneralPolygonWithHoles_2 */ }; /* end GeneralPolygonWithHoles_2 */