documentation formatting & swapped order of int and StringSplitOptions

dragon7307 · dragon7307 · commit dd932359ea28 · 2024-01-27T09:59:29.000+01:00
diff --git a/src/Enumerators/Split/SpanSplitEnumerator.cs b/src/Enumerators/Split/SpanSplitEnumerator.cs
@@ -28,7 +28,9 @@ public SpanSplitEnumerator(ReadOnlySpan<T> source, T delimiter)
             Current = default;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitEnumerator<T> GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/Split/SpanSplitStringSplitOptionsEnumerator.cs b/src/Enumerators/Split/SpanSplitStringSplitOptionsEnumerator.cs
@@ -30,7 +30,9 @@ public SpanSplitStringSplitOptionsEnumerator(ReadOnlySpan<char> source, char del
             Current = default;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitStringSplitOptionsEnumerator GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/Split/SpanSplitStringSplitOptionsWithCountEnumerator.cs b/src/Enumerators/Split/SpanSplitStringSplitOptionsWithCountEnumerator.cs
@@ -19,23 +19,25 @@ public ref struct SpanSplitStringSplitOptionsWithCountEnumerator
         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, int)"/></strong>.
+        /// Constructs a <see cref="SpanSplitStringSplitOptionsWithCountEnumerator"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.Split(ReadOnlySpan{char}, char, int, 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)
+        /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
+        public SpanSplitStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, char delimiter, int count, StringSplitOptions options)
         {
             Span = source;
             Delimiter = delimiter;
-            Options = options;
             Count = count;
+            Options = options;
             Current = default;
             currentCount = 0;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitStringSplitOptionsWithCountEnumerator GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/Split/SpanSplitWithCountEnumerator.cs b/src/Enumerators/Split/SpanSplitWithCountEnumerator.cs
@@ -33,7 +33,9 @@ public SpanSplitWithCountEnumerator(ReadOnlySpan<T> source, T delimiter, int cou
             currentCount = 0;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitWithCountEnumerator<T> GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/SplitAny/SpanSplitAnyEnumerator.cs b/src/Enumerators/SplitAny/SpanSplitAnyEnumerator.cs
@@ -29,7 +29,9 @@ public SpanSplitAnyEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delimiters
             Current = default;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitAnyEnumerator<T> GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/SplitAny/SpanSplitAnyStringSplitOptionsEnumerator.cs b/src/Enumerators/SplitAny/SpanSplitAnyStringSplitOptionsEnumerator.cs
@@ -30,7 +30,9 @@ public SpanSplitAnyStringSplitOptionsEnumerator(ReadOnlySpan<char> source, ReadO
             Current = default;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitAnyStringSplitOptionsEnumerator GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/SplitAny/SpanSplitAnyStringSplitOptionsWithCountEnumerator.cs b/src/Enumerators/SplitAny/SpanSplitAnyStringSplitOptionsWithCountEnumerator.cs
@@ -19,23 +19,25 @@ public ref struct SpanSplitAnyStringSplitOptionsWithCountEnumerator
         public ReadOnlySpan<char> Current { get; internal set; }
 
         /// <summary>
-        /// Constructs a <see cref="SpanSplitAnyStringSplitOptionsWithCountEnumerator"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.SplitAny(ReadOnlySpan{char}, ReadOnlySpan{char}, StringSplitOptions, int)"/></strong>.
+        /// Constructs a <see cref="SpanSplitAnyStringSplitOptionsWithCountEnumerator"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.SplitAny(ReadOnlySpan{char}, ReadOnlySpan{char}, int, 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>
         /// <param name="count">The maximum number of sub-ReadOnlySpans to split into.</param>
-        public SpanSplitAnyStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiters, StringSplitOptions options, int count)
+        /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
+        public SpanSplitAnyStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiters, int count, StringSplitOptions options)
         {
             Span = source;
             Delimiters = delimiters;
-            Options = options;
             Count = count;
+            Options = options;
             Current = default;
             currentCount = 0;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitAnyStringSplitOptionsWithCountEnumerator GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/SplitAny/SpanSplitAnyWithCountEnumerator.cs b/src/Enumerators/SplitAny/SpanSplitAnyWithCountEnumerator.cs
@@ -33,7 +33,9 @@ public SpanSplitAnyWithCountEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> d
             currentCount = 0;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitAnyWithCountEnumerator<T> GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/SplitSequence/SpanSplitSequenceEnumerator.cs b/src/Enumerators/SplitSequence/SpanSplitSequenceEnumerator.cs
@@ -28,7 +28,9 @@ public SpanSplitSequenceEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delim
             Current = default;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitSequenceEnumerator<T> GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/SplitSequence/SpanSplitSequenceStringSplitOptionsEnumerator.cs b/src/Enumerators/SplitSequence/SpanSplitSequenceStringSplitOptionsEnumerator.cs
@@ -30,7 +30,9 @@ public SpanSplitSequenceStringSplitOptionsEnumerator(ReadOnlySpan<char> source,
             Current = default;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitSequenceStringSplitOptionsEnumerator GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/SplitSequence/SpanSplitSequenceStringSplitOptionsWithCountEnumerator.cs b/src/Enumerators/SplitSequence/SpanSplitSequenceStringSplitOptionsWithCountEnumerator.cs
@@ -19,23 +19,25 @@ public ref struct SpanSplitSequenceStringSplitOptionsWithCountEnumerator
         public ReadOnlySpan<char> Current { get; internal set; }
 
         /// <summary>
-        /// Constructs a <see cref="SpanSplitSequenceStringSplitOptionsWithCountEnumerator"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.Split(ReadOnlySpan{char}, ReadOnlySpan{char}, StringSplitOptions, int)"/></strong>.
+        /// Constructs a <see cref="SpanSplitSequenceStringSplitOptionsWithCountEnumerator"/> from a span and a delimiter. <strong>Only consume this class through <see cref="ReadOnlySpanExtensions.Split(ReadOnlySpan{char}, ReadOnlySpan{char}, int, StringSplitOptions)"/></strong>.
         /// </summary>
         /// <param name="source">The <see cref="ReadOnlySpan{Char}"/> to be split.</param>
         /// <param name="delimiter">An instance of <see cref="ReadOnlySpan{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 SpanSplitSequenceStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiter, StringSplitOptions options, int count)
+        public SpanSplitSequenceStringSplitOptionsWithCountEnumerator(ReadOnlySpan<char> source, ReadOnlySpan<char> delimiter, int count, StringSplitOptions options)
         {
             Span = source;
             Delimiter = delimiter;
-            Options = options;
             Count = count;
+            Options = options;
             Current = default;
             currentCount = 0;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitSequenceStringSplitOptionsWithCountEnumerator GetEnumerator()
         {
             return this;
diff --git a/src/Enumerators/SplitSequence/SpanSplitSequenceWithCountEnumerator.cs b/src/Enumerators/SplitSequence/SpanSplitSequenceWithCountEnumerator.cs
@@ -33,7 +33,9 @@ public SpanSplitSequenceWithCountEnumerator(ReadOnlySpan<T> source, ReadOnlySpan
             currentCount = 0;
         }
 
-        /// <summary>Returns an enumerator that iterates through a collection.</summary>
+        /// <summary>
+        /// Returns an enumerator that iterates through a collection.
+        /// </summary>
         public readonly SpanSplitSequenceWithCountEnumerator<T> GetEnumerator()
         {
             return this;
diff --git a/src/Extensions/ReadOnlySpan/ReadOnlySpanExtensions.Split.cs b/src/Extensions/ReadOnlySpan/ReadOnlySpanExtensions.Split.cs
@@ -51,12 +51,12 @@ public static SpanSplitStringSplitOptionsEnumerator Split(this ReadOnlySpan<char
         /// </summary>
         /// <param name="span">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="span"/>.</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>
+        /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
         /// <returns>An instance of the ref struct <see cref="SpanSplitAnyStringSplitOptionsWithCountEnumerator"/>, which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
-        public static SpanSplitStringSplitOptionsWithCountEnumerator Split(this ReadOnlySpan<char> span, char delimiter, StringSplitOptions options, int count)
+        public static SpanSplitStringSplitOptionsWithCountEnumerator Split(this ReadOnlySpan<char> span, char delimiter, int count, StringSplitOptions options)
         {
-            return new SpanSplitStringSplitOptionsWithCountEnumerator(span, delimiter, options, count);
+            return new SpanSplitStringSplitOptionsWithCountEnumerator(span, delimiter, count, options);
         }
 
         /// <summary>
@@ -101,12 +101,12 @@ public static SpanSplitAnyStringSplitOptionsEnumerator SplitAny(this ReadOnlySpa
         /// </summary>
         /// <param name="span">The <see cref="ReadOnlySpan{Char}"/> to be split.</param>
         /// <param name="delimiters">A <see cref="ReadOnlySpan{Char}"/>, that delimit the various sub-ReadOnlySpans in <paramref name="span"/>.</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>
+        /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
         /// <returns>An instance of the ref struct <see cref="SpanSplitAnyStringSplitOptionsWithCountEnumerator"/>, which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
-        public static SpanSplitAnyStringSplitOptionsWithCountEnumerator SplitAny(this ReadOnlySpan<char> span, ReadOnlySpan<char> delimiters, StringSplitOptions options, int count)
+        public static SpanSplitAnyStringSplitOptionsWithCountEnumerator SplitAny(this ReadOnlySpan<char> span, ReadOnlySpan<char> delimiters, int count, StringSplitOptions options)
         {
-            return new SpanSplitAnyStringSplitOptionsWithCountEnumerator(span, delimiters, options, count);
+            return new SpanSplitAnyStringSplitOptionsWithCountEnumerator(span, delimiters, count, options);
         }
 
         /// <summary>
@@ -151,12 +151,12 @@ public static SpanSplitSequenceStringSplitOptionsEnumerator Split(this ReadOnlyS
         /// </summary>
         /// <param name="span">The <see cref="ReadOnlySpan{Char}"/> to be split.</param>
         /// <param name="delimiter">An instance of <see cref="ReadOnlySpan{Char}"/> that delimits the various sub-ReadOnlySpans in <paramref name="span"/>.</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>
+        /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
         /// <returns>An instance of the ref struct <see cref="SpanSplitSequenceStringSplitOptionsWithCountEnumerator"/>, which works the same way as every <see cref="IEnumerator"/> does and can be used in a foreach construct.</returns>
-        public static SpanSplitSequenceStringSplitOptionsWithCountEnumerator Split(this ReadOnlySpan<char> span, ReadOnlySpan<char> delimiter, StringSplitOptions options, int count)
+        public static SpanSplitSequenceStringSplitOptionsWithCountEnumerator Split(this ReadOnlySpan<char> span, ReadOnlySpan<char> delimiter, int count, StringSplitOptions options)
         {
-            return new SpanSplitSequenceStringSplitOptionsWithCountEnumerator(span, delimiter, options, count);
+            return new SpanSplitSequenceStringSplitOptionsWithCountEnumerator(span, delimiter, count, options);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,9 @@ public SpanSplitEnumerator(ReadOnlySpan<T> source, T delimiter)`
`28`	`28`	`Current = default;`
`29`	`29`	`}`
`30`	`30`
`31`		`- /// <summary>Returns an enumerator that iterates through a collection.</summary>`
	`31`	`+ /// <summary>`
	`32`	`+ /// Returns an enumerator that iterates through a collection.`
	`33`	`+ /// </summary>`
`32`	`34`	`public readonly SpanSplitEnumerator<T> GetEnumerator()`
`33`	`35`	`{`
`34`	`36`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,9 @@ public SpanSplitStringSplitOptionsEnumerator(ReadOnlySpan<char> source, char del`
`30`	`30`	`Current = default;`
`31`	`31`	`}`
`32`	`32`
`33`		`- /// <summary>Returns an enumerator that iterates through a collection.</summary>`
	`33`	`+ /// <summary>`
	`34`	`+ /// Returns an enumerator that iterates through a collection.`
	`35`	`+ /// </summary>`
`34`	`36`	`public readonly SpanSplitStringSplitOptionsEnumerator GetEnumerator()`
`35`	`37`	`{`
`36`	`38`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,9 @@ public SpanSplitWithCountEnumerator(ReadOnlySpan<T> source, T delimiter, int cou`
`33`	`33`	`currentCount = 0;`
`34`	`34`	`}`
`35`	`35`
`36`		`- /// <summary>Returns an enumerator that iterates through a collection.</summary>`
	`36`	`+ /// <summary>`
	`37`	`+ /// Returns an enumerator that iterates through a collection.`
	`38`	`+ /// </summary>`
`37`	`39`	`public readonly SpanSplitWithCountEnumerator<T> GetEnumerator()`
`38`	`40`	`{`
`39`	`41`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,9 @@ public SpanSplitAnyEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delimiters`
`29`	`29`	`Current = default;`
`30`	`30`	`}`
`31`	`31`
`32`		`- /// <summary>Returns an enumerator that iterates through a collection.</summary>`
	`32`	`+ /// <summary>`
	`33`	`+ /// Returns an enumerator that iterates through a collection.`
	`34`	`+ /// </summary>`
`33`	`35`	`public readonly SpanSplitAnyEnumerator<T> GetEnumerator()`
`34`	`36`	`{`
`35`	`37`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,9 @@ public SpanSplitAnyStringSplitOptionsEnumerator(ReadOnlySpan<char> source, ReadO`
`30`	`30`	`Current = default;`
`31`	`31`	`}`
`32`	`32`
`33`		`- /// <summary>Returns an enumerator that iterates through a collection.</summary>`
	`33`	`+ /// <summary>`
	`34`	`+ /// Returns an enumerator that iterates through a collection.`
	`35`	`+ /// </summary>`
`34`	`36`	`public readonly SpanSplitAnyStringSplitOptionsEnumerator GetEnumerator()`
`35`	`37`	`{`
`36`	`38`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,9 @@ public SpanSplitAnyWithCountEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> d`
`33`	`33`	`currentCount = 0;`
`34`	`34`	`}`
`35`	`35`
`36`		`- /// <summary>Returns an enumerator that iterates through a collection.</summary>`
	`36`	`+ /// <summary>`
	`37`	`+ /// Returns an enumerator that iterates through a collection.`
	`38`	`+ /// </summary>`
`37`	`39`	`public readonly SpanSplitAnyWithCountEnumerator<T> GetEnumerator()`
`38`	`40`	`{`
`39`	`41`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,9 @@ public SpanSplitSequenceEnumerator(ReadOnlySpan<T> source, ReadOnlySpan<T> delim`
`28`	`28`	`Current = default;`
`29`	`29`	`}`
`30`	`30`
`31`		`- /// <summary>Returns an enumerator that iterates through a collection.</summary>`
	`31`	`+ /// <summary>`
	`32`	`+ /// Returns an enumerator that iterates through a collection.`
	`33`	`+ /// </summary>`
`32`	`34`	`public readonly SpanSplitSequenceEnumerator<T> GetEnumerator()`
`33`	`35`	`{`
`34`	`36`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,9 @@ public SpanSplitSequenceStringSplitOptionsEnumerator(ReadOnlySpan<char> source,`
`30`	`30`	`Current = default;`
`31`	`31`	`}`
`32`	`32`
`33`		`- /// <summary>Returns an enumerator that iterates through a collection.</summary>`
	`33`	`+ /// <summary>`
	`34`	`+ /// Returns an enumerator that iterates through a collection.`
	`35`	`+ /// </summary>`
`34`	`36`	`public readonly SpanSplitSequenceStringSplitOptionsEnumerator GetEnumerator()`
`35`	`37`	`{`
`36`	`38`	`return this;`