refactored, added documentation

Author: Petr Sramek

src/PolylineAlgorithm/Validation/CoordinateValidator.cs

@@ -4,26 +4,28 @@
 //
 
 namespace PolylineAlgorithm.Validation;
-/// <summary>
-/// Initializes an instance of coordinate validator.
-/// </summary>
-/// <remarks>
-/// Initializes an instance of coordinate validator.
-/// </remarks>
-/// <param name="latitudeRange">A latitude range.</param>
-/// <param name="longitudeRange">A longitude range.</param>
-public sealed class CoordinateValidator(CoordinateRange latitudeRange, CoordinateRange longitudeRange) : ICoordinateValidator {
-    /// <summary>
-    /// A latitude validation range.
-    /// </summary>
-    public CoordinateRange Latitude { get; } = latitudeRange;
 
+/// <inheritdoc cref="ICoordinateValidator" />
+public sealed class CoordinateValidator : ICoordinateValidator {
     /// <summary>
-    /// A longitude validation range.
+    /// Creates a new <see cref="CoordinateValidator"/> class that uses
+    /// specified <paramref name="latitudeRange"/> and <paramref name="longitudeRange"/> to determine if <see cref="Coordinate"/> value is valid.
     /// </summary>
-    public CoordinateRange Longitude { get; } = longitudeRange;
+    /// <param name="latitudeRange"></param>
+    /// <param name="longitudeRange"></param>
+    public CoordinateValidator(CoordinateRange latitudeRange, CoordinateRange longitudeRange) {
+        Latitude = latitudeRange;
+        Longitude = longitudeRange;
+    }
+
+    /// <inheritdoc/>
+    public CoordinateRange Latitude { get; }
+
+    /// <inheritdoc/>
+    public CoordinateRange Longitude { get; }
 
-    public bool IsValid(ref readonly Coordinate coordinate) {
+    /// <inheritdoc/>
+    public bool IsValid(Coordinate coordinate) {
         return
             Latitude.IsInRange(coordinate.Latitude)
             && Longitude.IsInRange(coordinate.Longitude);

src/PolylineAlgorithm/Validation/ICoordinateValidator.cs

@@ -8,28 +8,28 @@ namespace PolylineAlgorithm.Validation;
 using PolylineAlgorithm.Internal;
 
 /// <summary>
-/// Defines proprties and methods used for validating coordinates.
+/// Provides a mechanism for validating <see cref="Coordinate"/> structure and its values, Latitude and Longitude.
 /// </summary>
 public interface ICoordinateValidator {
     /// <summary>
-    /// Represents latitude validation range
+    /// Gets latitude validation range.
     /// </summary>
     CoordinateRange Latitude { get; }
 
     /// <summary>
-    /// Represents longitude validation range
+    /// Gets longitude validation range.
     /// </summary>
     CoordinateRange Longitude { get; }
 
     /// <summary>
-    /// Validates coordinate.
+    /// Returns a value indicating whether <see cref="Coordinate" /> is valid.
     /// </summary>
-    /// <param name="coordinate"></param>
-    /// <returns><see langword="true"/></returns>
-    bool IsValid(ref readonly Coordinate coordinate);
+    /// <param name="coordinate">The coordinate to be validated.</param>
+    /// <returns><see langword="true"/> if <paramref name="coordinate"/> is valid; otherwise, <see langword="false"/>.</returns>
+    bool IsValid(Coordinate coordinate);
 
     /// <summary>
-    /// Represents global coordinate validator instance.
+    /// Represents default coordinate validator instance.
     /// </summary>
-    internal static ICoordinateValidator Default { get; private set; } = new CoordinateValidator(Defaults.Coordinate.Range.Latitude, Defaults.Coordinate.Range.Longitude);
+    internal static ICoordinateValidator Default { get; } = new CoordinateValidator(Defaults.Coordinate.Range.Latitude, Defaults.Coordinate.Range.Longitude);
 }