Document General_polygon_2 constructor using curve

This commit is contained in:
Simon Giraudot 2020-08-31 14:18:51 +02:00
parent 96c5d90243
commit af079b90e2
1 changed files with 18 additions and 0 deletions

View File

@ -35,6 +35,24 @@ number of edges size type.
*/
typedef unspecified_type Size;
/*!
a general planar curve.
*/
typedef typename ArrTraits::Curve_2 Curve_2;
/// @}
/// \name Construction
/// @{
/*!
constructs a `General_polygon_2` from a curve.
\note The curve is divided into \f$ x\f$-monotone curves using
`ArrTraits::Make_x_monotone_2`.
*/
General_polygon_2 (const Curve_2& curve);
/// @}
/// \name Operations