added documentation

Author: Petr Sramek

benchmarks/PolylineAlgorithm.Benchmarks/PolylineDecoderBenchmark.cs

@@ -9,27 +9,48 @@ namespace PolylineAlgorithm.Benchmarks;
 using BenchmarkDotNet.Engines;
 using PolylineAlgorithm;
 
+/// <summary>
+/// Benchmarks for the <see cref="PolylineDecoder"/> class.
+/// </summary>
 [RankColumn]
 public class PolylineDecoderBenchmark {
     private readonly Consumer _consumer = new();
 
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
+    /// <summary>
+    /// Gets the string value representing the encoded polyline.
+    /// </summary>
     public string StringValue { get; private set; }
+
+    /// <summary>
+    /// Gets the character array representing the encoded polyline.
+    /// </summary>
     public char[] CharArray { get; private set; }
 
-#pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
+    /// <summary>
+    /// Gets the read-only memory representing the encoded polyline.
+    /// </summary>
     public ReadOnlyMemory<char> Memory { get; private set; }
+#pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
 
-
+    /// <summary>
+    /// The polyline decoder instance.
+    /// </summary>
     public PolylineDecoder Decoder = new();
 
+    /// <summary>
+    /// Sets up the data for the benchmarks.
+    /// </summary>
     [GlobalSetup]
     public void SetupData() {
         StringValue = @"sq_|Fptm{UrbxoHinoiEuhmbHctjfc@`rocCt|nfJgiauLvc_uIh`pg_@h_fkVgctZoyqfW{rxgQhhymFpuvvDwqcfTlqbcBiegdTwf{uNngc|z@{vhlDnsi_B~nz`O}d_hNp{n`E}kcoKm`bCiul~\jhg|Hv{qoWshzh\{lf_G`pzMqm|bLzswoQbhcm`@b`}cIgignPgxntR|}vo^f~|}L}|_jBa|ujWuxkjQfj|w[wsz`Pmdb{XohnwA`srxWjitms@c_~`Tava_l@jxxcF`d|zHcpnaMnd{kYzccwPxzpiHfsxlL}jjjQqvdbIikyvj@cjdqTh`zoDzqleHnfmik@tbnoB_t}gFkzx_Ct_eiP`wxrBcd_|w@zlhfPtlxgBkwyyZn|~tFlpj|HxqiwUnddkFoo|nTee}dSfkcg`@py`uQiguom@zkkpEfcgkAntuuDzl~il@ir_gCrd~nI_ryeC_qmmMl_kgCz`qgFzkejBmlchYyp`hZ`_cuYzuc}Onqz}Ew~Gcsmj@lp{Hqj_gz@ne{pJnny~]g{tuNxbno[lfq_Lqhwjt@qn|cCuxnMyivuIh{|tR`ylsQlqbfO}rf`LxghfBg~{nAv`gdNbjh_Fglt|NfxwyBowwhW{bdtNdbkqe@rxtwSy{_fX{btm@va`_LkhwuUyqgzK`xdnKgbwsFigt_Mofdn\h|x[ccoPtbpvNz}skb@pl~xEqascV_wsx[`f_z]zewFs`zjAhturWxayhJqmfaAjmhhHxwuwF_aru@ojemVq|beu@kkucBdmryTevflDcbmdAnp|dHfpbd^io}z@e~}dFzcybQ}`hxOyt|bNl}blLnuspKk|t|k@itjfHt}}aVyzmcF_rgmLct}x@bazdq@loajBxygb@f}krVgnuqOcrx_Daqvp_@ew}yUn}kpU|uwnItashEpe_aHusi{Fsu}_Ewfhv[dzhzKxh_qXucxfXmynkGxuqbW|ppgi@vrsq@clryZk`bt^spkyP";
         CharArray = StringValue.ToCharArray();
         Memory = StringValue.AsMemory();
     }
 
+    /// <summary>
+    /// Benchmarks the decoding of a polyline from a string.
+    /// </summary>
     [Benchmark]
     public void PolylineDecoder_Decode_FromString() {
         Polyline polyline = Polyline.FromString(StringValue);
@@ -39,6 +60,9 @@ public void PolylineDecoder_Decode_FromString() {
             .Consume(_consumer);
     }
 
+    /// <summary>
+    /// Benchmarks the decoding of a polyline from a character array.
+    /// </summary>
     [Benchmark]
     public void PolylineDecoder_Decode_FromCharArray() {
         Polyline polyline = Polyline.FromCharArray(CharArray);
@@ -48,6 +72,9 @@ public void PolylineDecoder_Decode_FromCharArray() {
             .Consume(_consumer);
     }
 
+    /// <summary>
+    /// Benchmarks the decoding of a polyline from read-only memory.
+    /// </summary>
     [Benchmark]
     public void PolylineDecoder_Decode_FromMemory() {
         Polyline polyline = Polyline.FromMemory(Memory);
@@ -56,4 +83,4 @@ public void PolylineDecoder_Decode_FromMemory() {
             .Decode(in polyline)
             .Consume(_consumer);
     }
-}
+}

benchmarks/PolylineAlgorithm.Benchmarks/PolylineEncoderBenchmark.cs

@@ -9,34 +9,54 @@ namespace PolylineAlgorithm.Benchmarks;
 using PolylineAlgorithm;
 using System.Collections.Generic;
 
+/// <summary>
+/// Benchmarks for the <see cref="PolylineEncoder"/> class.
+/// </summary>
 [RankColumn]
 public class PolylineEncoderBenchmark {
     private static readonly Random R = new();
 
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
+    /// <summary>
+    /// Gets the enumeration of coordinates to be encoded.
+    /// </summary>
     public static IEnumerable<Coordinate> Enumeration { get; private set; }
 
+    /// <summary>
+    /// Gets the list of coordinates to be encoded.
+    /// </summary>
     public static List<Coordinate> List { get; private set; }
-
 #pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
 
+    /// <summary>
+    /// The polyline encoder instance.
+    /// </summary>
     public PolylineEncoder Encoder = new();
 
+    /// <summary>
+    /// Sets up the data for the benchmarks.
+    /// </summary>
     [GlobalSetup]
     public void SetupData() {
         Enumeration = Enumerable.Range(0, 100).Select(i => new Coordinate(R.Next(-90, 90) + R.NextDouble(), R.Next(-180, 180) + R.NextDouble()));
-        List = [.. Enumeration];
+        List = new List<Coordinate>(Enumeration);
     }
 
+    /// <summary>
+    /// Benchmarks the encoding of a list of coordinates into a polyline.
+    /// </summary>
+    /// <returns>The encoded polyline.</returns>
     [Benchmark]
     public Polyline PolylineEncoder_Encode_List() {
-        return Encoder
-            .Encode(List!);
+        return Encoder.Encode(List!);
     }
 
+    /// <summary>
+    /// Benchmarks the encoding of an enumeration of coordinates into a polyline.
+    /// </summary>
+    /// <returns>The encoded polyline.</returns>
     [Benchmark]
     public Polyline PolylineEncoder_Encode_Enumerator() {
-        return Encoder
-            .Encode(Enumeration!);
+        return Encoder.Encode(Enumeration!);
     }
-}
+}

benchmarks/PolylineAlgorithm.Benchmarks/Program.cs

@@ -8,10 +8,17 @@ namespace PolylineAlgorithm.Benchmarks;
 using BenchmarkDotNet.Configs;
 using BenchmarkDotNet.Running;
 
+/// <summary>
+/// The main entry point for the benchmark application.
+/// </summary>
 internal class Program {
+    /// <summary>
+    /// The main method that runs the benchmarks.
+    /// </summary>
+    /// <param name="args">The command-line arguments.</param>
     static void Main(string[] args) {
         BenchmarkSwitcher
             .FromAssembly(typeof(Program).Assembly)
             .Run(args, DefaultConfig.Instance);
     }
-}
+}