docs

Author: SimonCropp

src/Polyfill/Polyfill_Memory_SpanSort.cs

@@ -1,20 +1,25 @@
-#if FeatureMemory
+#if FeatureMemory && !NET5_0_OR_GREATER
 
 namespace Polyfills;
 
-#if !NET5_0_OR_GREATER
 using System;
 using System.Collections.Generic;
 using System.Buffers;
-#endif
 
 static partial class Polyfill
 {
-#if  !NET5_0_OR_GREATER
+    /// <summary>
+    /// Sorts the elements in the entire <see cref="Span{T}"/> using the <see cref="IComparable{T}"/> implementation of each element of the <see cref="Span{T}"/>.
+    /// </summary>
+    //Link: https://learn.microsoft.com/en-us/dotnet/api/system.memoryextensions.sort?view=net-10.0#system-memoryextensions-sort-1(system-span((-0)))
     public static void Sort<T>(this Span<T> source)
         where T : IComparable<T>
         => Sort(source, (x, y) => x.CompareTo(y));
 
+    /// <summary>
+    /// Sorts the elements in the entire <see cref="Span{T}"/> using the specified <see cref="Comparison{T}"/>.
+    /// </summary>
+    /// Link: https://learn.microsoft.com/en-us/dotnet/api/system.memoryextensions.sort?view=net-10.0#system-memoryextensions-sort-1(system-span((-0))-system-comparison((-0)))
     public static void Sort<T>(this Span<T> source, Comparison<T> comparison)
     {
         if((Comparison<T>?)comparison is null)
@@ -35,9 +40,18 @@ public static void Sort<T>(this Span<T> source, Comparison<T> comparison)
         }
     }
 
+    /// <summary>
+    /// Sorts a pair of spans (one containing the keys and the other containing the corresponding items) based on the keys in the first <see cref="Span{T}"/> using the <see cref=" IComparable{T}"/> implementation of each key.
+    /// </summary>
+    //Link: https://learn.microsoft.com/en-us/dotnet/api/system.memoryextensions.sort?view=net-10.0#system-memoryextensions-sort-2(system-span((-0))-system-span((-1)))
     public static void Sort<TKey, TValue>(this Span<TKey> keys, Span<TValue> values)
         => Sort(keys, values, Comparer<TKey>.Default);
 
+
+    /// <summary>
+    /// Sorts a pair of spans (one containing the keys and the other containing the corresponding items) based on the keys in the first <see cref="Span{T}"/>  using the specified comparer.
+    /// </summary>
+    //Link: https://learn.microsoft.com/en-us/dotnet/api/system.memoryextensions.sort?view=net-10.0#system-memoryextensions-sort-3(system-span((-0))-system-span((-1))-2)
     public static void Sort<TKey, TValue, TComparer>(this Span<TKey> keys, Span<TValue> values, TComparer comparer)
         where TComparer : IComparer<TKey>
     {
@@ -66,10 +80,14 @@ public static void Sort<TKey, TValue, TComparer>(this Span<TKey> keys, Span<TVal
         }
     }
 
-    public static void Sort<TKey, TValue>(this Span<TKey> keys, Span<TValue> values, Comparison<TKey> comparison)
-        => Sort(keys, values, new ComparerWrapper<TKey>(comparison));
+    /// <summary>
+    /// Sorts a pair of spans (one containing the keys and the other containing the corresponding items) based on the keys in the first <see cref="Span{T}"/> using the specified comparison.
+    /// </summary>
+    //Link: https://learn.microsoft.com/en-us/dotnet/api/system.memoryextensions.sort?view=net-10.0#system-memoryextensions-sort-2(system-span((-0))-system-span((-1))-system-comparison((-0)))
+    public static void Sort<TKey, TValue>(this Span<TKey> keys, Span<TValue> items, Comparison<TKey> comparison)
+        => Sort(keys, items, new ComparerWrapper<TKey>(comparison));
 
-    private class ComparerWrapper<T> : IComparer<T>
+    class ComparerWrapper<T> : IComparer<T>
     {
         readonly Comparison<T> comparison;
 
@@ -89,7 +107,6 @@ public int Compare(T? x, T? y)
             return comparison((T)x, (T)y);
         }
     }
-#endif
 }
 
-#endif
+#endif