diff --git a/lib/src/nearest_point_on_line.dart b/lib/src/nearest_point_on_line.dart index 72e924af..52afb4d4 100644 --- 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: [