Skip to content

Commit d358f3e

Browse files
gregmeessrms80
authored andcommitted
Add comment summary strings.
1 parent a6dd51d commit d358f3e

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

curve/GeneralPolygon2d.cs

+4-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,10 @@ public bool Contains(Polygon2d poly) {
188188
return true;
189189
}
190190

191-
191+
/// <summary>
192+
/// Checks that all points on a segment are within the area defined by the GeneralPolygon2d;
193+
/// holes are included in the calculation.
194+
/// </summary>
192195
public bool Contains(Segment2d seg)
193196
{
194197
if (outer.Contains(seg) == false)

curve/Polygon2d.cs

+6
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,9 @@ public bool Contains(Polygon2d o) {
333333
return true;
334334
}
335335

336+
/// <summary>
337+
/// Checks that all points on a segment are within the area defined by the Polygon2d.
338+
/// </summary>
336339
public bool Contains(Segment2d o)
337340
{
338341
// [TODO] Add bbox check
@@ -360,6 +363,9 @@ public bool Intersects(Polygon2d o) {
360363
return false;
361364
}
362365

366+
/// <summary>
367+
/// Checks if any point on a segment is within the area defined by the Polygon2d.
368+
/// </summary>
363369
public bool Intersects(Segment2d o)
364370
{
365371
// [TODO] Add bbox check

0 commit comments

Comments
 (0)