From 61d51502c02c0096d5e5cfa75b8aad12b53c88dd Mon Sep 17 00:00:00 2001 From: Efi Fogel Date: Mon, 6 Apr 2020 16:37:46 +0300 Subject: [PATCH] Fixed documentation of intersection return types --- .../Concepts/ArrTraits--Intersect_2.h | 2 +- .../ArrDirectionalTraits--Intersect_2.h | 35 +++++++++---------- 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h index 9d65d678de0..146eb151548 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h @@ -18,7 +18,7 @@ public: /*! computes the intersections of `xc1` and `xc2` and inserts them in an * ascending lexicographic \f$ xy\f$-order into a range begining at - * `oi`. The value-type of `OutputIterator` is `boost::variant` of either the + * `oi`. The type `OutputIterator` dereferences a `boost::variant` of either the * type `pair` or the type * `ArrTraits::X_monotone_curve_2`. An object of the former type represents an * intersection point with its multiplicity (in case the multiplicity is diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h index 4d09d1f41e3..76efa0e5073 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h @@ -16,24 +16,23 @@ public: /// A model of this concept must provide: /// @{ -/*! -computes the intersections of `xc1` and `xc2` and -inserts them in an ascending lexicographic \f$ xy\f$-order into the -output iterator `oi`. The value-type of `Output_iterator` is -`CGAL::Object`, where each `Object` wraps either a -`pair` object, which -represents an intersection point with its multiplicity (in case the -multiplicity is undefined or unknown, it is set to \f$ 0\f$) or an -`ArrDirectionalTraits::X_monotone_curve_2` object, representing an -overlapping subcurve of `xc1` and `xc2`. In the latter case, -the overlapping subcurves are given the direction of `xc1` and -`xc2` if their directions are identical. Otherwise, the overlapping -subcurves are given an arbitrary direction. The operator returns a -past-the-end iterator for the output sequence. -*/ -Output_iterator operator()(ArrDirectionalTraits::X_monotone_curve_2 xc1, -ArrDirectionalTraits::X_monotone_curve_2 xc2, -Output_iterator& oi); +/*! computes the intersections of `xc1` and `xc2` and inserts them in an + * ascending lexicographic \f$ xy\f$-order into a range begining at + * `oi`. The type `OutputIterator` dereferences a `boost::variant` of either the + * type `pair` or the type + * `ArrDirectionalTraits::X_monotone_curve_2`. An object of the former type + * represents an intersection point with its multiplicity (in case the + * multiplicity is undefined or unknown, it is set to \f$ 0\f$). An object of + * the latter type representing an overlapping subcurve of `xc1` and `xc2`. The + * overlapping subcurves are given the direction of `xc1` and `xc2` if their + * directions are identical. Otherwise, the overlapping subcurves are given an + * arbitrary direction. The operator returns a past-the-end iterator of the + * destination range. + */ +OutputIterator operator()(ArrDirectionalTraits::X_monotone_curve_2 xc1, + ArrDirectionalTraits::X_monotone_curve_2 xc2, + Output_iterator& oi); /// @}