Lots of improvements to the codebase, including XMLDocs, extension blocks, and code reductions due to implicit span conversion, and CallerArgumentExpressions.

Author: MrMatthewLayton

OnixLabs.Core.UnitTests/Linq/IEnumerableExtensionTests.cs

@@ -23,123 +23,123 @@ namespace OnixLabs.Core.Collections;
 public static partial class Collection
 {
     /// <summary>
-    /// Creates an empty enumerable.
+    /// Creates an empty <see cref="IEnumerable{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the enumerable.</typeparam>
     /// <returns>Returns an empty enumerable.</returns>
     public static IEnumerable<T> EmptyEnumerable<T>() => [];
 
     /// <summary>
-    /// Creates an empty array.
+    /// Creates an empty <typeparamref name="T"/> array.
     /// </summary>
     /// <typeparam name="T">The underlying type of the array.</typeparam>
     /// <returns>Returns an empty array.</returns>
     public static T[] EmptyArray<T>() => [];
 
     /// <summary>
-    /// Creates an empty immutable array.
+    /// Creates an empty <see cref="ImmutableArray{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the immutable array.</typeparam>
     /// <returns>Returns an empty immutable array.</returns>
     public static ImmutableArray<T> EmptyImmutableArray<T>() => [];
 
     /// <summary>
-    /// Creates an empty list.
+    /// Creates an empty <see cref="List{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the list.</typeparam>
     /// <returns>Returns an empty list.</returns>
     public static List<T> EmptyList<T>() => [];
 
     /// <summary>
-    /// Creates an empty immutable list.
+    /// Creates an empty <see cref="ImmutableList{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the immutable list.</typeparam>
     /// <returns>Returns an empty immutable list.</returns>
     public static ImmutableList<T> EmptyImmutableList<T>() => [];
 
     /// <summary>
-    /// Creates an empty dictionary.
+    /// Creates an empty <see cref="Dictionary{TKey,TValue}"/>.
     /// </summary>
     /// <typeparam name="TKey">The underlying type of the dictionary key.</typeparam>
     /// <typeparam name="TValue">The underlying type of the dictionary value.</typeparam>
     /// <returns>Returns an empty dictionary.</returns>
     public static Dictionary<TKey, TValue> EmptyDictionary<TKey, TValue>() where TKey : notnull => [];
 
     /// <summary>
-    /// Creates an empty immutable dictionary.
+    /// Creates an empty <see cref="ImmutableDictionary{TKey,TValue}"/>.
     /// </summary>
     /// <typeparam name="TKey">The underlying type of the immutable dictionary key.</typeparam>
     /// <typeparam name="TValue">The underlying type of the immutable dictionary value.</typeparam>
     /// <returns>Returns an empty immutable dictionary.</returns>
     public static ImmutableDictionary<TKey, TValue> EmptyImmutableDictionary<TKey, TValue>() where TKey : notnull => ImmutableDictionary<TKey, TValue>.Empty;
 
     /// <summary>
-    /// Creates an empty sorted dictionary.
+    /// Creates an empty <see cref="SortedDictionary{TKey,TValue}"/>.
     /// </summary>
     /// <typeparam name="TKey">The underlying type of the sorted dictionary key.</typeparam>
     /// <typeparam name="TValue">The underlying type of the sorted dictionary value.</typeparam>
     /// <returns>Returns an empty sorted dictionary.</returns>
     public static SortedDictionary<TKey, TValue> EmptySortedDictionary<TKey, TValue>() where TKey : notnull => [];
 
     /// <summary>
-    /// Creates an empty immutable sorted dictionary.
+    /// Creates an empty <see cref="ImmutableSortedDictionary{TKey,TValue}"/>.
     /// </summary>
     /// <typeparam name="TKey">The underlying type of the immutable sorted dictionary key.</typeparam>
     /// <typeparam name="TValue">The underlying type of the immutable sorted dictionary value.</typeparam>
     /// <returns>Returns an empty immutable sorted dictionary.</returns>
     public static ImmutableSortedDictionary<TKey, TValue> EmptyImmutableSortedDictionary<TKey, TValue>() where TKey : notnull => ImmutableSortedDictionary<TKey, TValue>.Empty;
 
     /// <summary>
-    /// Creates an empty hash set.
+    /// Creates an empty <see cref="HashSet{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the hash set.</typeparam>
     /// <returns>Returns an empty hash set.</returns>
     public static HashSet<T> EmptyHashSet<T>() => [];
 
     /// <summary>
-    /// Creates an empty immutable hash set.
+    /// Creates an empty <see cref="ImmutableHashSet{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the immutable hash set.</typeparam>
     /// <returns>Returns an empty immutable hash set.</returns>
     public static ImmutableHashSet<T> EmptyImmutableHashSet<T>() => [];
 
     /// <summary>
-    /// Creates an empty sorted set.
+    /// Creates an empty <see cref="SortedSet{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the sorted set.</typeparam>
     /// <returns>Returns an empty sorted set.</returns>
     public static SortedSet<T> EmptySortedSet<T>() => [];
 
     /// <summary>
-    /// Creates an empty immutable sorted set.
+    /// Creates an empty <see cref="ImmutableSortedSet{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the immutable sorted set.</typeparam>
     /// <returns>Returns an empty immutable sorted set.</returns>
     public static ImmutableSortedSet<T> EmptyImmutableSortedSet<T>() => [];
 
     /// <summary>
-    /// Creates an empty stack.
+    /// Creates an empty <see cref="Stack{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the stack.</typeparam>
     /// <returns>Returns an empty stack.</returns>
     public static Stack<T> EmptyStack<T>() => [];
 
     /// <summary>
-    /// Creates an empty immutable stack.
+    /// Creates an empty <see cref="ImmutableStack{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the immutable stack.</typeparam>
     /// <returns>Returns an empty immutable stack.</returns>
     public static ImmutableStack<T> EmptyImmutableStack<T>() => [];
 
     /// <summary>
-    /// Creates an empty queue.
+    /// Creates an empty <see cref="Queue{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the queue.</typeparam>
     /// <returns>Returns an empty queue.</returns>
     public static Queue<T> EmptyQueue<T>() => [];
 
     /// <summary>
-    /// Creates an empty immutable queue.
+    /// Creates an empty <see cref="ImmutableQueue{T}"/>.
     /// </summary>
     /// <typeparam name="T">The underlying type of the immutable queue.</typeparam>
     /// <returns>Returns an empty immutable queue.</returns>

OnixLabs.Core/Collections/Collection.Empty.cs

@@ -18,114 +18,115 @@
 
 namespace OnixLabs.Core.Collections;
 
+// ReSharper disable MemberCanBePrivate.Global
 public static partial class Collection
 {
     /// <summary>
-    /// Creates an enumerable of the specified items.
+    /// Creates an <see cref="IEnumerable{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the enumerable.</param>
     /// <typeparam name="T">The underlying type of the enumerable.</typeparam>
     /// <returns>Returns an enumerable populated with the specified items.</returns>
     public static IEnumerable<T> EnumerableOf<T>(params IEnumerable<T> items) => items;
 
     /// <summary>
-    /// Creates an array of the specified items.
+    /// Creates a <typeparamref name="T"/> array of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the array.</param>
     /// <typeparam name="T">The underlying type of the array.</typeparam>
     /// <returns>Returns an array populated with the specified items.</returns>
     public static T[] ArrayOf<T>(params T[] items) => items;
 
     /// <summary>
-    /// Creates an immutable array of the specified items.
+    /// Creates an <see cref="ImmutableArray{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the immutable array.</param>
     /// <typeparam name="T">The underlying type of the immutable array.</typeparam>
     /// <returns>Returns an immutable array populated with the specified items.</returns>
     public static ImmutableArray<T> ImmutableArrayOf<T>(params ImmutableArray<T> items) => items;
 
     /// <summary>
-    /// Creates a list of the specified items.
+    /// Creates a <see cref="List{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the list.</param>
     /// <typeparam name="T">The underlying type of the list.</typeparam>
     /// <returns>Returns a list populated with the specified items.</returns>
     public static List<T> ListOf<T>(params List<T> items) => items;
 
     /// <summary>
-    /// Creates an immutable list of the specified items.
+    /// Creates an <see cref="ImmutableList{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the immutable list.</param>
     /// <typeparam name="T">The underlying type of the immutable list.</typeparam>
     /// <returns>Returns an immutable list populated with the specified items.</returns>
     public static ImmutableList<T> ImmutableListOf<T>(params ImmutableList<T> items) => items;
 
     /// <summary>
-    /// Creates a hash set of the specified items.
+    /// Creates a <see cref="HashSet{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the hash set.</param>
     /// <typeparam name="T">The underlying type of the hash set.</typeparam>
     /// <returns>Returns a hash set populated with the specified items.</returns>
     public static HashSet<T> HashSetOf<T>(params HashSet<T> items) => items;
 
     /// <summary>
-    /// Creates an immutable hash set of the specified items.
+    /// Creates an <see cref="ImmutableHashSet{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the immutable hash set.</param>
     /// <typeparam name="T">The underlying type of the immutable hash set.</typeparam>
     /// <returns>Returns an immutable hash set populated with the specified items.</returns>
     public static ImmutableHashSet<T> ImmutableHashSetOf<T>(params ImmutableHashSet<T> items) => items;
 
     /// <summary>
-    /// Creates a sorted set of the specified items.
+    /// Creates a <see cref="SortedSet{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the sorted set.</param>
     /// <typeparam name="T">The underlying type of the sorted set.</typeparam>
     /// <returns>Returns a sorted set populated with the specified items.</returns>
     public static SortedSet<T> SortedSetOf<T>(params SortedSet<T> items) => items;
 
     /// <summary>
-    /// Creates an immutable sorted set of the specified items.
+    /// Creates an <see cref="ImmutableSortedSet{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the immutable sorted set.</param>
     /// <typeparam name="T">The underlying type of the immutable sorted set.</typeparam>
     /// <returns>Returns an immutable sorted set populated with the specified items.</returns>
     public static ImmutableSortedSet<T> ImmutableSortedSetOf<T>(params ImmutableSortedSet<T> items) => items;
 
     /// <summary>
-    /// Creates a stack of the specified items.
+    /// Creates a <see cref="Stack{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the stack.</param>
     /// <typeparam name="T">The underlying type of the stack.</typeparam>
     /// <returns>Returns a stack populated with the specified items.</returns>
     public static Stack<T> StackOf<T>(params IEnumerable<T> items) => new(items);
 
     /// <summary>
-    /// Creates an immutable stack of the specified items.
+    /// Creates an <see cref="ImmutableStack{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the immutable stack.</param>
     /// <typeparam name="T">The underlying type of the immutable stack.</typeparam>
     /// <returns>Returns an immutable stack populated with the specified items.</returns>
     public static ImmutableStack<T> ImmutableStackOf<T>(params ImmutableStack<T> items) => items;
 
     /// <summary>
-    /// Creates a queue of the specified items.
+    /// Creates a <see cref="Queue{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the queue.</param>
     /// <typeparam name="T">The underlying type of the queue.</typeparam>
     /// <returns>Returns a queue populated with the specified items.</returns>
     public static Queue<T> QueueOf<T>(params IEnumerable<T> items) => new(items);
 
     /// <summary>
-    /// Creates an immutable queue of the specified items.
+    /// Creates an <see cref="ImmutableQueue{T}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which will populate the immutable queue.</param>
     /// <typeparam name="T">The underlying type of the immutable queue.</typeparam>
     /// <returns>Returns an immutable queue populated with the specified items.</returns>
     public static ImmutableQueue<T> ImmutableQueueOf<T>(params ImmutableQueue<T> items) => items;
 
     /// <summary>
-    /// Create a dictionary of the specified items.
+    /// Create a <see cref="Dictionary{TKey,TValue}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which wil populate the dictionary.</param>
     /// <typeparam name="TKey">The underlying type of the dictionary key.</typeparam>
@@ -135,7 +136,7 @@ public static Dictionary<TKey, TValue> DictionaryOf<TKey, TValue>
         (params IEnumerable<KeyValuePair<TKey, TValue>> items) where TKey : notnull => new(items);
 
     /// <summary>
-    /// Create a dictionary of the specified items.
+    /// Create a <see cref="Dictionary{TKey,TValue}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which wil populate the dictionary.</param>
     /// <typeparam name="TKey">The underlying type of the dictionary key.</typeparam>
@@ -146,7 +147,7 @@ public static Dictionary<TKey, TValue> DictionaryOf<TKey, TValue>
         DictionaryOf(items.Select(item => new KeyValuePair<TKey, TValue>(item.key, item.value)));
 
     /// <summary>
-    /// Create an immutable dictionary of the specified items.
+    /// Create an <see cref="ImmutableDictionary{TKey,TValue}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which wil populate the immutable dictionary.</param>
     /// <typeparam name="TKey">The underlying type of the immutable dictionary key.</typeparam>
@@ -156,7 +157,7 @@ public static ImmutableDictionary<TKey, TValue> ImmutableDictionaryOf<TKey, TVal
         (params IEnumerable<KeyValuePair<TKey, TValue>> items) where TKey : notnull => ImmutableDictionary.CreateRange(items);
 
     /// <summary>
-    /// Create an immutable dictionary of the specified items.
+    /// Create an <see cref="ImmutableDictionary{TKey,TValue}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which wil populate the immutable dictionary.</param>
     /// <typeparam name="TKey">The underlying type of the immutable dictionary key.</typeparam>
@@ -167,7 +168,7 @@ public static ImmutableDictionary<TKey, TValue> ImmutableDictionaryOf<TKey, TVal
         ImmutableDictionary.CreateRange(items.Select(item => new KeyValuePair<TKey, TValue>(item.key, item.value)));
 
     /// <summary>
-    /// Create a sorted dictionary of the specified items.
+    /// Create a <see cref="SortedDictionary{TKey,TValue}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which wil populate the sorted dictionary.</param>
     /// <typeparam name="TKey">The underlying type of the sorted dictionary key.</typeparam>
@@ -177,7 +178,7 @@ public static SortedDictionary<TKey, TValue> SortedDictionaryOf<TKey, TValue>
         (params IEnumerable<KeyValuePair<TKey, TValue>> items) where TKey : notnull => new(DictionaryOf(items));
 
     /// <summary>
-    /// Create a sorted dictionary of the specified items.
+    /// Create a <see cref="SortedDictionary{TKey,TValue}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which wil populate the sorted dictionary.</param>
     /// <typeparam name="TKey">The underlying type of the sorted dictionary key.</typeparam>
@@ -187,7 +188,7 @@ public static SortedDictionary<TKey, TValue> SortedDictionaryOf<TKey, TValue>
         (params IEnumerable<(TKey key, TValue value)> items) where TKey : notnull => new(DictionaryOf(items));
 
     /// <summary>
-    /// Create an immutable sorted dictionary of the specified items.
+    /// Create an <see cref="ImmutableSortedDictionary{TKey,TValue}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which wil populate the immutable sorted dictionary.</param>
     /// <typeparam name="TKey">The underlying type of the immutable sorted dictionary key.</typeparam>
@@ -197,7 +198,7 @@ public static ImmutableSortedDictionary<TKey, TValue> ImmutableSortedDictionaryO
         (params IEnumerable<KeyValuePair<TKey, TValue>> items) where TKey : notnull => ImmutableSortedDictionary.CreateRange(items);
 
     /// <summary>
-    /// Create an immutable sorted dictionary of the specified items.
+    /// Create an <see cref="ImmutableSortedDictionary{TKey,TValue}"/> of the specified items.
     /// </summary>
     /// <param name="items">The items which wil populate the immutable sorted dictionary.</param>
     /// <typeparam name="TKey">The underlying type of the immutable sorted dictionary key.</typeparam>

OnixLabs.Core/Collections/Collection.Of.cs

@@ -22,30 +22,30 @@ namespace OnixLabs.Core;
 public abstract partial class Enumeration<T>
 {
     /// <summary>
-    /// Gets all of the enumeration entries for the current type.
+    /// Gets all the enumeration entries for the current type.
     /// </summary>
-    /// <returns>Returns all of the enumeration entries for the current type.</returns>
+    /// <returns>Returns all the enumeration entries for the current type.</returns>
     public static IReadOnlySet<T> GetAll() => typeof(T)
         .GetFields(BindingFlags.Public | BindingFlags.Static | BindingFlags.DeclaredOnly)
         .Select(field => field.GetValue(null))
         .OfType<T>()
         .ToFrozenSet();
 
     /// <summary>
-    /// Gets all of the enumeration entries for the current type.
+    /// Gets all the enumeration entries for the current type.
     /// </summary>
-    /// <returns>Returns all of the enumeration entries for the current type.</returns>
+    /// <returns>Returns all the enumeration entries for the current type.</returns>
     public static IReadOnlySet<(int Value, string Name)> GetEntries() => GetAll().Select(entry => entry.ToEntry()).ToFrozenSet();
 
     /// <summary>
-    /// Gets all of the enumeration names for the current type.
+    /// Gets all the enumeration names for the current type.
     /// </summary>
-    /// <returns>Returns all of the enumeration names for the current type.</returns>
+    /// <returns>Returns all the enumeration names for the current type.</returns>
     public static IReadOnlySet<string> GetNames() => GetAll().Select(entry => entry.Name).ToFrozenSet();
 
     /// <summary>
-    /// Gets all of the enumeration values for the current type.
+    /// Gets all the enumeration values for the current type.
     /// </summary>
-    /// <returns>Returns all of the enumeration values for the current type.</returns>
+    /// <returns>Returns all the enumeration values for the current type.</returns>
     public static IReadOnlySet<int> GetValues() => GetAll().Select(entry => entry.Value).ToFrozenSet();
 }