Skip to content

Commit 30e015e

Browse files
author
Petr Sramek
committed
Imporved documentation for PolylineEncoder
1 parent cdc34c8 commit 30e015e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/PolylineAlgorithm/PolylineEncoder.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ namespace PolylineAlgorithm;
1313
using System.Runtime.CompilerServices;
1414

1515
/// <summary>
16-
/// Performs polyline algorithm encoding
16+
/// Provides methods to encode a set of coordinates into a polyline string.
1717
/// </summary>
1818
public class PolylineEncoder : IPolylineEncoder {
1919
/// <summary>
20-
/// Encodes a set of coordinates to polyline.
20+
/// Encodes a set of coordinates into a polyline string.
2121
/// </summary>
22-
/// <param name="coordinates">Coordinates to encode.</param>
23-
/// <returns>Polyline encoded representation.</returns>
24-
/// <exception cref="ArgumentNullException">Thrown when <paramref name="coordinates"/> argument is null.</exception>
25-
/// <exception cref="ArgumentException">Thrown when <paramref name="coordinates"/> argument is empty enumeration.</exception>
22+
/// <param name="coordinates">The coordinates to encode.</param>
23+
/// <returns>A <see cref="Polyline"/> representing the encoded coordinates.</returns>
24+
/// <exception cref="ArgumentNullException">Thrown when the <paramref name="coordinates"/> argument is null.</exception>
25+
/// <exception cref="ArgumentException">Thrown when the <paramref name="coordinates"/> argument is an empty enumeration.</exception>
2626
public Polyline Encode(IEnumerable<Coordinate> coordinates) {
2727
if (coordinates is null) {
2828
throw new ArgumentNullException(nameof(coordinates));

0 commit comments

Comments
 (0)