Document properties set by NearestPointOnLine on returned Point (#155)

dartclub · Jan 25, 2024 · c3537d6 · c3537d6
1 parent bbccfb3
commit c3537d6
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/lib/src/nearest_point_on_line.dart b/lib/src/nearest_point_on_line.dart
@@ -183,6 +183,13 @@ _NearestMulti? _nearestPointOnMultiLine(
 }
 
 /// Takes a [Point] and a [LineString] and calculates the closest Point on the [LineString].
+///
+/// The properties of returned [Point] will contain three values:
+/// * index: closest point was found on nth line part
+/// * dist: distance between [point] and the closest point on line
+/// * location: distance along the line between start and the closest point.
+///
+/// Example:
 /// ```dart
 /// var line = LineString(
 ///   coordinates: [