Skip to content

Commit ab9cf40

Browse files
MaelRLMaelRL
committed
Do not use misleading variable names
1 parent 6e74b88 commit ab9cf40

2 files changed

Lines changed: 12 additions & 13 deletions

File tree

‎Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_offset_polygons_from_polygon_with_holes_2.h‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ namespace CGAL {
55
/*!
66
\ingroup PkgStraightSkeleton2OffsetFunctions
77
8-
\brief returns a container with all the inner offset polygons <I>with holes</I> at distance `offset`
9-
of the 2D polygon with holes `poly_with_holes`.
8+
\brief returns a container with all the inner offset polygons <I>with holes</I> at distance `offset` of the 2D polygon `poly`.
109
11-
This is equivalent to `arrange_offset_polygons_2(create_interior_skeleton_and_offset_polygons_2(offset, poly_with_holes, ofk, ssk))`.
10+
This is equivalent to `arrange_offset_polygons_2(create_interior_skeleton_and_offset_polygons_2(offset, poly, ofk, ssk))`.
1211
1312
\tparam OfKPolygon is a polygon without holes type determined by `OfK` and `InKPolygon`,
1413
see Section \ref SLSOffsetPolygonReturnType.
@@ -34,7 +33,7 @@ template <class OfKPolygon,
3433
class SsK = CGAL::Exact_predicates_inexact_constructions_kernel>
3534
std::vector< std::shared_ptr< OfKPolygon > >
3635
create_interior_skeleton_and_offset_polygons_with_holes_2(const FT& offset,
37-
const InKPolygon& poly_with_holes,
36+
const InKPolygon& poly,
3837
const OfK& ofk = OfK(),
3938
const SsK& ssk = SsK());
4039

@@ -45,11 +44,11 @@ create_interior_skeleton_and_offset_polygons_with_holes_2(const FT& offset,
4544
\ingroup PkgStraightSkeleton2OffsetFunctions
4645
4746
\brief returns a container with all the outer offset polygons <I>with holes</I>
48-
at distance `offset` of the 2D polygon `poly_with_holes`. Note that the
47+
at distance `offset` of the 2D polygon `poly`. Note that the
4948
offset of the outer frame is ignored.
5049
5150
This is equivalent to a call to `CGAL::arrange_offset_polygons_2()` on the
52-
output of \link CGAL::create_exterior_skeleton_and_offset_polygons_2() `create_exterior_skeleton_and_offset_polygons_2(offset, poly_with_holes, ofk, ssk)` \endlink
51+
output of \link CGAL::create_exterior_skeleton_and_offset_polygons_2() `create_exterior_skeleton_and_offset_polygons_2(offset, poly, ofk, ssk)` \endlink
5352
after having filtered out the polygon corresponding to the offset of the outer frame and
5453
having reversed the orientation of all other polygons.
5554
@@ -76,7 +75,7 @@ template <class OfKPolygon,
7675
class SsK = CGAL::Exact_predicates_inexact_constructions_kernel>
7776
std::vector<std::shared_ptr<OfKPolygon> >
7877
create_exterior_skeleton_and_offset_polygons_with_holes_2(const FT& offset,
79-
const InKPolygon& poly_with_holes,
78+
const InKPolygon& poly,
8079
const OfK& ofk = OfK(),
8180
const SsK& ssk = SsK());
8281

‎Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_weighted_offset_polygons_from_polygon_with_holes_2.h‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ namespace CGAL {
66
\ingroup PkgStraightSkeleton2WeightedOffsetFunctions
77
88
\brief returns a container with all the inner offset polygons <I>with holes</I> at distance `offset`
9-
of the 2D polygon with holes `poly_with_holes`.
9+
of the 2D polygon `poly`.
1010
11-
This is equivalent to `arrange_offset_polygons_2(create_interior_weighted_skeleton_and_offset_polygons_2(offset, poly_with_holes, ofk, ssk))`.
11+
This is equivalent to `arrange_offset_polygons_2(create_interior_weighted_skeleton_and_offset_polygons_2(offset, poly, ofk, ssk))`.
1212
1313
\tparam OfKPolygon is a polygon without holes type determined by `OfK` and `InKPolygon`,
1414
see Section \ref SLSOffsetPolygonReturnType.
@@ -35,7 +35,7 @@ template <typename OfKPolygon,
3535
typename SsK = CGAL::Exact_predicates_inexact_constructions_kernel>
3636
std::vector< std::shared_ptr< OfKPolygon > >
3737
create_interior_weighted_skeleton_and_offset_polygons_with_holes_2(const FT& offset,
38-
const InKPolygon& poly_with_holes,
38+
const InKPolygon& poly,
3939
const InKWeights& weights,
4040
const OfK& ofk = OfK(),
4141
const SsK& ssk = SsK());
@@ -47,11 +47,11 @@ create_interior_weighted_skeleton_and_offset_polygons_with_holes_2(const FT& off
4747
\ingroup PkgStraightSkeleton2WeightedOffsetFunctions
4848
4949
\brief returns a container with all the outer offset polygons <I>with holes</I>
50-
at distance `offset` of the 2D polygon `poly_with_holes`. Note that the
50+
at distance `offset` of the 2D polygon `poly`. Note that the
5151
offset of the outer frame is ignored.
5252
5353
This is equivalent to a call to `CGAL::arrange_offset_polygons_2()` on the
54-
output of \link CGAL::create_exterior_weighted_skeleton_and_offset_polygons_2() `create_exterior_weighted_skeleton_and_offset_polygons_2(offset, poly_with_holes, ofk, ssk)` \endlink
54+
output of \link CGAL::create_exterior_weighted_skeleton_and_offset_polygons_2() `create_exterior_weighted_skeleton_and_offset_polygons_2(offset, poly, ofk, ssk)` \endlink
5555
after having filtered out the polygon corresponding to the offset of the outer frame and
5656
having reversed the orientation of all other polygons.
5757
@@ -80,7 +80,7 @@ template <typename OfKPolygon,
8080
typename SsK = CGAL::Exact_predicates_inexact_constructions_kernel>
8181
std::vector<std::shared_ptr<OfKPolygon> >
8282
create_exterior_weighted_skeleton_and_offset_polygons_with_holes_2(const FT& offset,
83-
const InKPolygon& poly_with_holes,
83+
const InKPolygon& poly,
8484
const InKWeights& weights,
8585
const OfK& ofk = OfK(),
8686
const SsK& ssk = SsK());

0 commit comments

Comments
 (0)