documentation comments cleanup (#8)

- removed extra white spaces and lines
- fixed incorrect type references
- changed boolean code blocks to see-langword tags
- added missing doc-comments
- changed some type references to parameter references to remove ambiguity
- added missing punctuations
- reworded some comments to closer match examples in the .NET documentation
- fixed some comments

Author: Guiorgy

src/Enumerators/Split/SpanSplitEnumerator.cs

@@ -5,29 +5,30 @@ namespace SpanExtensions.Enumerators
     /// <summary>
     /// Supports iteration over a <see cref="ReadOnlySpan{T}"/> by splitting it at a specified delimiter of type <typeparamref name="T"/>.
     /// </summary>
-    /// <typeparam name="T">The type of elements in the enumerated <see cref="ReadOnlySpan{T}"/></typeparam>
+    /// <typeparam name="T">The type of elements in the enumerated <see cref="ReadOnlySpan{T}"/>.</typeparam>
     public ref struct SpanSplitEnumerator<T> where T : IEquatable<T>
     {
         ReadOnlySpan<T> Span;
         readonly T Delimiter;
 
         /// <summary>
-        /// Gets the element in the collection at the current position of the enumerator. 
+        /// Gets the element in the collection at the current position of the enumerator.
         /// </summary>
         public ReadOnlySpan<T> Current { get; internal set; }
 
         /// <summary>
-        /// Constructs a <see cref="SpanSplitEnumerator{T}"/> from a span and a delimiter. ONLY CONSUME THIS CLASS THROUGH <see cref="ReadOnlySpanExtensions.Split{T}(ReadOnlySpan{T}, T)"/>. 
+        /// Constructs a <see cref="SpanSplitEnumerator{T}"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.Split{T}(ReadOnlySpan{T}, T)"/></strong>.
         /// </summary>
-        /// <param name="source">The <see cref="ReadOnlySpan{T}"/> to be split.</param>  
-        /// <param name="delimiter">An instance of <typeparamref name="T"/> that delimits the various sub-ReadOnlySpans in the <see cref="ReadOnlySpan{T}"/>.</param>
+        /// <param name="source">The <see cref="ReadOnlySpan{T}"/> to be split.</param>
+        /// <param name="delimiter">An instance of <typeparamref name="T"/> that delimits the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
         public SpanSplitEnumerator(ReadOnlySpan<T> source, T delimiter)
         {
             Span = source;
             Delimiter = delimiter;
             Current = default;
         }
-        /// <summary></summary>
+
+        /// <summary>Returns an enumerator that iterates through a collection.</summary>
         public readonly SpanSplitEnumerator<T> GetEnumerator()
         {
             return this;
@@ -36,7 +37,7 @@ public readonly SpanSplitEnumerator<T> GetEnumerator()
         /// <summary>
         /// Advances the enumerator to the next element of the collection.
         /// </summary>
-        /// <returns><code>true</code> if the enumerator was successfully advanced to the next element; <code>false</code> if the enumerator has passed the end of the collection.</returns>
+        /// <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
         public bool MoveNext()
         {
             ReadOnlySpan<T> span = Span;

src/Enumerators/Split/SpanSplitStringSplitOptionsEnumerator.cs

@@ -2,25 +2,25 @@
 
 namespace SpanExtensions.Enumerators
 {
-    /// <summary> 
-    /// Supports iteration over a <see cref="ReadOnlySpan{Char}"/> by splitting it at a specified delimiter and based on specified <see cref="StringSplitOptions"/>.  
-    /// </summary>   
+    /// <summary>
+    /// Supports iteration over a <see cref="ReadOnlySpan{Char}"/> by splitting it at a specified delimiter and based on specified <see cref="StringSplitOptions"/>.
+    /// </summary>
     public ref struct SpanSplitStringSplitOptionsEnumerator
     {
         ReadOnlySpan<char> Span;
         readonly char Delimiter;
         readonly StringSplitOptions Options;
 
         /// <summary>
-        /// Gets the element in the collection at the current position of the enumerator. 
+        /// Gets the element in the collection at the current position of the enumerator.
         /// </summary>
         public ReadOnlySpan<char> Current { get; internal set; }
 
         /// <summary>
-        /// Constructs a <see cref="SpanSplitEnumerator{Char}"/> from a span and a delimiter. ONLY CONSUME THIS CLASS THROUGH <see cref="ReadOnlySpanExtensions.Split(ReadOnlySpan{char}, char, StringSplitOptions)"/>. 
+        /// Constructs a <see cref="SpanSplitStringSplitOptionsEnumerator"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.Split(ReadOnlySpan{char}, char, StringSplitOptions)"/></strong>.
         /// </summary>
-        /// <param name="source">The <see cref="ReadOnlySpan{Char}"/> to be split.</param>  
-        /// <param name="delimiter">An <see cref="char"/> that delimits the various sub-ReadOnlySpans in the <see cref="ReadOnlySpan{Char}"/>.</param>
+        /// <param name="source">The <see cref="ReadOnlySpan{Char}"/> to be split.</param>
+        /// <param name="delimiter">A <see cref="char"/> that delimits the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
         /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
         public SpanSplitStringSplitOptionsEnumerator(ReadOnlySpan<char> source, char delimiter, StringSplitOptions options)
         {
@@ -29,16 +29,17 @@ public SpanSplitStringSplitOptionsEnumerator(ReadOnlySpan<char> source, char del
             Options = options;
             Current = default;
         }
-        /// <summary></summary>
+
+        /// <summary>Returns an enumerator that iterates through a collection.</summary>
         public readonly SpanSplitStringSplitOptionsEnumerator GetEnumerator()
         {
             return this;
         }
-        
+
         /// <summary>
         /// Advances the enumerator to the next element of the collection.
         /// </summary>
-        /// <returns><code>true</code> if the enumerator was successfully advanced to the next element; <code>false</code> if the enumerator has passed the end of the collection.</returns>
+        /// <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
         public bool MoveNext()
         {
             ReadOnlySpan<char> span = Span;

src/Enumerators/Split/SpanSplitStringSplitOptionsWithCountEnumerator.cs

@@ -2,9 +2,9 @@
 
 namespace SpanExtensions.Enumerators
 {
-    /// <summary> 
-    /// Supports iteration over a <see cref="ReadOnlySpan{Char}"/> by splitting it at a specified delimiter and based on specified <see cref="StringSplitOptions"/>  with an upper limit of splits performed.  
-    /// </summary>   
+    /// <summary>
+    /// Supports iteration over a <see cref="ReadOnlySpan{Char}"/> by splitting it at a specified delimiter and based on specified <see cref="StringSplitOptions"/>  with an upper limit of splits performed.
+    /// </summary>
     public ref struct SpanSplitStringSplitOptionsWithCountEnumerator
     {
         ReadOnlySpan<char> Span;
@@ -14,10 +14,17 @@ public ref struct SpanSplitStringSplitOptionsWithCountEnumerator
         int currentCount;
 
         /// <summary>
-        /// Gets the element in the collection at the current position of the enumerator. 
+        /// Gets the element in the collection at the current position of the enumerator.
         /// </summary>
         public ReadOnlySpan<char> Current { get; internal set; }
 
+        /// <summary>
+        /// Constructs a <see cref="SpanSplitStringSplitOptionsWithCountEnumerator"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.Split(ReadOnlySpan{char}, char, StringSplitOptions)"/></strong>.
+        /// </summary>
+        /// <param name="source">The <see cref="ReadOnlySpan{Char}"/> to be split.</param>
+        /// <param name="delimiter">A <see cref="char"/> that delimits the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
+        /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
+        /// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
         public SpanSplitStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, char delimiter, StringSplitOptions options, int count)
         {
             Span = source;
@@ -27,7 +34,8 @@ public SpanSplitStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source,
             Current = default;
             currentCount = 0;
         }
-        /// <summary></summary>
+
+        /// <summary>Returns an enumerator that iterates through a collection.</summary>
         public readonly SpanSplitStringSplitOptionsWithCountEnumerator GetEnumerator()
         {
             return this;
@@ -36,7 +44,7 @@ public readonly SpanSplitStringSplitOptionsWithCountEnumerator GetEnumerator()
         /// <summary>
         /// Advances the enumerator to the next element of the collection.
         /// </summary>
-        /// <returns><code>true</code> if the enumerator was successfully advanced to the next element; <code>false</code> if the enumerator has passed the end of the collection.</returns>
+        /// <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
         public bool MoveNext()
         {
             ReadOnlySpan<char> span = Span;

src/Enumerators/Split/SpanSplitWithCountEnumerator.cs

@@ -5,7 +5,7 @@ namespace SpanExtensions.Enumerators
     /// <summary>
     /// Supports iteration over a <see cref="ReadOnlySpan{T}"/> by splitting it a a specified delimiter of type <typeparamref name="T"/> with an upper limit of splits performed.
     /// </summary>
-    /// <typeparam name="T">The type of elements in the enumerated <see cref="ReadOnlySpan{T}"/></typeparam>
+    /// <typeparam name="T">The type of elements in the enumerated <see cref="ReadOnlySpan{T}"/>.</typeparam>
     public ref struct SpanSplitWithCountEnumerator<T> where T : IEquatable<T>
     {
         ReadOnlySpan<T> Span;
@@ -14,10 +14,16 @@ namespace SpanExtensions.Enumerators
         int currentCount;
 
         /// <summary>
-        /// Gets the element in the collection at the current position of the enumerator. 
+        /// Gets the element in the collection at the current position of the enumerator.
         /// </summary>
         public ReadOnlySpan<T> Current { get; internal set; }
 
+        /// <summary>
+        /// Constructs a <see cref="SpanSplitWithCountEnumerator{T}"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.Split{T}(ReadOnlySpan{T}, T)"/></strong>.
+        /// </summary>
+        /// <param name="source">The <see cref="ReadOnlySpan{T}"/> to be split.</param>
+        /// <param name="delimiter">An instance of <typeparamref name="T"/> that delimits the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
+        /// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
         public SpanSplitWithCountEnumerator(ReadOnlySpan<T> source, T delimiter, int count)
         {
             Span = source;
@@ -26,7 +32,8 @@ public SpanSplitWithCountEnumerator(ReadOnlySpan<T> source, T delimiter, int cou
             Current = default;
             currentCount = 0;
         }
-        /// <summary></summary>
+
+        /// <summary>Returns an enumerator that iterates through a collection.</summary>
         public readonly SpanSplitWithCountEnumerator<T> GetEnumerator()
         {
             return this;
@@ -35,7 +42,7 @@ public readonly SpanSplitWithCountEnumerator<T> GetEnumerator()
         /// <summary>
         /// Advances the enumerator to the next element of the collection.
         /// </summary>
-        /// <returns><code>true</code> if the enumerator was successfully advanced to the next element; <code>false</code> if the enumerator has passed the end of the collection.</returns>
+        /// <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
         public bool MoveNext()
         {
             ReadOnlySpan<T> span = Span;

src/Enumerators/SplitAny/SpanSplitAnyEnumerator.cs

@@ -4,26 +4,32 @@ namespace SpanExtensions.Enumerators
 {
 
     /// <summary>
-    /// Supports iteration over a <see cref="ReadOnlySpan{T}"/> by splitting it at specified delimiters of type <typeparamref name="T"/>. 
+    /// Supports iteration over a <see cref="ReadOnlySpan{T}"/> by splitting it at specified delimiters of type <typeparamref name="T"/>.
     /// </summary>
-    /// <typeparam name="T">The type of elements in the enumerated <see cref="ReadOnlySpan{T}"/></typeparam>  
+    /// <typeparam name="T">The type of elements in the enumerated <see cref="ReadOnlySpan{T}"/>.</typeparam>
     public ref struct SpanSplitAnyEnumerator<T> where T : IEquatable<T>
     {
         ReadOnlySpan<T> Span;
         readonly ReadOnlySpan<T> Delimiters;
 
         /// <summary>
-        /// Gets the element in the collection at the current position of the enumerator. 
+        /// Gets the element in the collection at the current position of the enumerator.
         /// </summary>
         public ReadOnlySpan<T> Current { get; internal set; }
 
+        /// <summary>
+        /// Constructs a <see cref="SpanSplitAnyEnumerator{T}"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.SplitAny{T}(ReadOnlySpan{T}, ReadOnlySpan{T})"/></strong>.
+        /// </summary>
+        /// <param name="source">The <see cref="ReadOnlySpan{T}"/> to be split.</param>
+        /// <param name="delimiters">A <see cref="ReadOnlySpan{T}"/> with the instances of <typeparamref name="T"/> that delimit the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
         public SpanSplitAnyEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delimiters)
         {
             Span = source;
             Delimiters = delimiters;
             Current = default;
         }
-        /// <summary></summary>
+
+        /// <summary>Returns an enumerator that iterates through a collection.</summary>
         public readonly SpanSplitAnyEnumerator<T> GetEnumerator()
         {
             return this;
@@ -32,7 +38,7 @@ public readonly SpanSplitAnyEnumerator<T> GetEnumerator()
         /// <summary>
         /// Advances the enumerator to the next element of the collection.
         /// </summary>
-        /// <returns><code>true</code> if the enumerator was successfully advanced to the next element; <code>false</code> if the enumerator has passed the end of the collection.</returns>
+        /// <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
         public bool MoveNext()
         {
             ReadOnlySpan<T> span = Span;

src/Enumerators/SplitAny/SpanSplitAnyStringSplitOptionsEnumerator.cs

@@ -2,28 +2,35 @@
 
 namespace SpanExtensions.Enumerators
 {
-    /// <summary> 
-    /// Supports iteration over a <see cref="ReadOnlySpan{Char}"/> by splitting it at specified delimiters and based on specified <see cref="StringSplitOptions"/>.  
-    /// </summary>   
+    /// <summary>
+    /// Supports iteration over a <see cref="ReadOnlySpan{Char}"/> by splitting it at specified delimiters and based on specified <see cref="StringSplitOptions"/>.
+    /// </summary>
     public ref struct SpanSplitAnyStringSplitOptionsEnumerator
     {
         ReadOnlySpan<char> Span;
         readonly ReadOnlySpan<char> Delimiters;
         readonly StringSplitOptions Options;
 
         /// <summary>
-        /// Gets the element in the collection at the current position of the enumerator. 
+        /// Gets the element in the collection at the current position of the enumerator.
         /// </summary>
         public ReadOnlySpan<char> Current { get; internal set; }
 
+        /// <summary>
+        /// Constructs a <see cref="SpanSplitAnyStringSplitOptionsEnumerator"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.SplitAny(ReadOnlySpan{char}, ReadOnlySpan{char}, StringSplitOptions)"/></strong>.
+        /// </summary>
+        /// <param name="source">The <see cref="ReadOnlySpan{Char}"/> to be split.</param>
+        /// <param name="delimiters">A <see cref="ReadOnlySpan{Char}"/> with the <see cref="char"/> elements that delimit the various sub-ReadOnlySpans in <paramref name="source"/>.</param>
+        /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
         public SpanSplitAnyStringSplitOptionsEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiters, StringSplitOptions options)
         {
             Span = source;
             Delimiters = delimiters;
             Options = options;
             Current = default;
         }
-        /// <summary></summary>
+
+        /// <summary>Returns an enumerator that iterates through a collection.</summary>
         public readonly SpanSplitAnyStringSplitOptionsEnumerator GetEnumerator()
         {
             return this;
@@ -32,7 +39,7 @@ public readonly SpanSplitAnyStringSplitOptionsEnumerator GetEnumerator()
         /// <summary>
         /// Advances the enumerator to the next element of the collection.
         /// </summary>
-        /// <returns><code>true</code> if the enumerator was successfully advanced to the next element; <code>false</code> if the enumerator has passed the end of the collection.</returns>
+        /// <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
         public bool MoveNext()
         {
             ReadOnlySpan<char> span = Span;