From 0f9983b0368bc13e9bfba2d779bc18771d69cea8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Tue, 11 Apr 2023 09:57:36 +0200 Subject: [PATCH] Doc fixes --- .../Concepts/PolygonOffsetBuilderTraits_2.h | 10 ++++++++-- .../Concepts/StraightSkeletonBuilderTraits_2.h | 12 ++---------- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h index f212ff4a593..4188620b70b 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h @@ -20,7 +20,10 @@ public: /*! A predicate object type. -Must provide `Comparison_result operator()( FT d, const Trisegment_2_ptr& et) const`, +Must provide + +`Comparison_result operator()( FT d, const Trisegment_2_ptr& et) const`, + which compares the Euclidean distance `d` with the event time for `et`. Such event time is the Euclidean distance at which the offset lines intersect in a single point. The source of such offset lines is given by the three oriented lines defined by the edge-triple `et`. @@ -33,7 +36,10 @@ typedef unspecified_type Compare_offset_against_event_time_2; /*! A construction object type. -Must provide `boost::optional operator()(const FT& t, const Segment_2& e0, const Segment_2& e1, const Trisegment_2_ptr& et) const`, +Must provide + +`boost::optional operator()(const FT& t, const Segment_2& e0, const Segment_2& e1, const Trisegment_2_ptr& et) const`, + which constructs the point of intersection of the lines obtained by offsetting the oriented lines given by `e0` and `e0` an Euclidean distance `t`. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h index f57b2b8e5c9..bdb3b62b2e3 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h @@ -123,12 +123,7 @@ typedef unspecified_type Construct_ss_event_time_and_point_2; /*! A construction object type. -Must provide `Trisegment_2_ptr operator()( const Segment_2& e0, - const FT& w0, - const Segment_2& e1, - const FT& w1, - const Segment_2& e2, - const FT& w2 ) const`, +Must provide `Trisegment_2_ptr operator()( const Segment_2& e0, const FT& w0, const Segment_2& e1, const FT& w1, const Segment_2& e2, const FT& w2 ) const`, which returns an intrusive pointer to an object containing the three oriented lines defined by the three input edges. @@ -160,10 +155,7 @@ A predicate object type. Must provide -`CGAL::Oriented_side operator()( const Trisegment_2_ptr& e, - const Segment_2& e0, const FT& w0, - const Segment_2& e1, const FT& w1, - const Trisegment_2_ptr& e01_event, bool e0_is_primary) const`, +`CGAL::Oriented_side operator()( const Trisegment_2_ptr& e, const Segment_2& e0, const FT& w0, const Segment_2& e1, const FT& w1, const Trisegment_2_ptr& e01_event, bool e0_is_primary) const`, which returns the oriented side of the event point described by the edge triple `e` w.r.t. the (positive) bisector `[e0,e1]`.