Fixed inheritdoc usage.

Author: electricessence

Source/Extensions.Equals.cs

@@ -130,11 +130,11 @@ public static bool TrimmedEquals(this string? source, in ReadOnlySpan<char> othe
 			};
 		}
 
-		/// <inheritdoc cref="TrimmedEquals(string, in ReadOnlySpan{char}, StringComparison)"/>
 		/// <summary>
 		/// Optimized equals for comparing a trimmed string with another string.
 		/// </summary>
 		/// <param name="other">The string to compare to.</param>
+		/// <inheritdoc cref="TrimmedEquals(string, in ReadOnlySpan{char}, StringComparison)"/>
 		public static bool TrimmedEquals(this string? source, string? other, StringComparison stringComparison = StringComparison.Ordinal)
 		{
 			if (source is null) return other is null;
@@ -153,8 +153,8 @@ public static bool TrimmedEquals(this string? source, string? other, StringCompa
 		}
 
 
-		/// <inheritdoc cref="TrimmedEquals(string, in ReadOnlySpan{char}, StringComparison)"/>
 		/// <param name="trimChar">The character to trim.</param>
+		/// <inheritdoc cref="TrimmedEquals(string, in ReadOnlySpan{char}, StringComparison)"/>
 		public static bool TrimmedEquals(this string? source, in ReadOnlySpan<char> other, char trimChar, StringComparison stringComparison = StringComparison.Ordinal)
 		{
 			if (source is null) return false;
@@ -171,8 +171,8 @@ public static bool TrimmedEquals(this string? source, in ReadOnlySpan<char> othe
 			};
 		}
 
-		/// <inheritdoc cref="TrimmedEquals(string?, string?, StringComparison)"/>
 		/// <param name="trimChar">The character to trim.</param>
+		/// <inheritdoc cref="TrimmedEquals(string?, string?, StringComparison)"/>
 		public static bool TrimmedEquals(this string? source, string? other, char trimChar, StringComparison stringComparison = StringComparison.Ordinal)
 		{
 			if (source is null) return other is null;
@@ -190,8 +190,8 @@ public static bool TrimmedEquals(this string? source, string? other, char trimCh
 			};
 		}
 
-		/// <inheritdoc cref="TrimmedEquals(string, in ReadOnlySpan{char}, StringComparison)"/>
 		/// <param name="trimChars">The characters to trim.</param>
+		/// <inheritdoc cref="TrimmedEquals(string, in ReadOnlySpan{char}, StringComparison)"/>
 		public static bool TrimmedEquals(this string? source, in ReadOnlySpan<char> other, in ReadOnlySpan<char> trimChars, StringComparison stringComparison = StringComparison.Ordinal)
 		{
 			if (source is null) return false;
@@ -208,8 +208,8 @@ public static bool TrimmedEquals(this string? source, in ReadOnlySpan<char> othe
 			};
 		}
 
-		/// <inheritdoc cref="TrimmedEquals(string?, string?, StringComparison)"/>
 		/// <param name="trimChars">The characters to trim.</param>
+		/// <inheritdoc cref="TrimmedEquals(string?, string?, StringComparison)"/>
 		public static bool TrimmedEquals(this string? source, string? other, in ReadOnlySpan<char> trimChars, StringComparison stringComparison = StringComparison.Ordinal)
 		{
 			if (source is null) return other is null;

Source/Extensions.Split.cs

@@ -53,8 +53,8 @@ static ReadOnlyMemory<char> FirstSplitMemory(string source, int start, int i, in
 		}
 
 
-		/// <inheritdoc cref="FirstSplit(ReadOnlySpan{char}, char, out int)"/>
 		/// <param name="startIndex">The index to start the split.</param>
+		/// <inheritdoc cref="FirstSplit(ReadOnlySpan{char}, char, out int)"/>
 		public static ReadOnlySpan<char> FirstSplit(this string source,
 			char splitCharacter,
 			out int nextIndex,
@@ -74,8 +74,8 @@ public static ReadOnlySpan<char> FirstSplit(this string source,
 			return FirstSplitSpan(source, startIndex, source.IndexOf(splitCharacter, startIndex), 1, out nextIndex);
 		}
 
-		/// <inheritdoc cref="FirstSplit(ReadOnlySpan{char}, ReadOnlySpan{char}, out int, StringComparison)"/>
 		/// <param name="startIndex">The index to start the split.</param>
+		/// <inheritdoc cref="FirstSplit(ReadOnlySpan{char}, ReadOnlySpan{char}, out int, StringComparison)"/>
 		public static ReadOnlySpan<char> FirstSplit(this string source,
 			string splitSequence,
 			out int nextIndex,

Source/Extensions.StringSegment.cs

@@ -12,13 +12,13 @@ public static partial class Extensions
 		public static StringSegment AsSegment(this string source)
 			=> StringSegment.Create(source);
 
-		/// <inheritdoc cref="AsSegment(string)"/>
 		/// <param name="start">The index to start the segment.</param>
+		/// <inheritdoc cref="AsSegment(string)"/>
 		public static StringSegment AsSegment(this string source, int start)
 			=> StringSegment.Create(source, start);
 
-		/// <inheritdoc cref="AsSegment(string, int)"/>
 		/// <param name="length">The length of the segment.</param>
+		/// <inheritdoc cref="AsSegment(string, int)"/>
 		public static StringSegment AsSegment(this string source, int start, int length)
 			=> StringSegment.Create(source, start, length);
 
@@ -87,10 +87,10 @@ public static StringSegment First(this StringSegment source, string search, Stri
 			return First(source, search.AsSpan(), comparisonType);
 		}
 
-		/// <inheritdoc cref="First(string, string, StringComparison)"/>
 		/// <summary>
 		/// Finds the last instance of a string and returns a StringSegment for subsequent use.
 		/// </summary>
+		/// <inheritdoc cref="First(string, string, StringComparison)"/>
 		public static StringSegment Last(this string source, string search, StringComparison comparisonType = StringComparison.Ordinal)
 		{
 			if (source is null) throw new ArgumentNullException(nameof(source));
@@ -104,11 +104,11 @@ public static StringSegment Last(this string source, string search, StringCompar
 			return i == -1 ? default : StringSegment.Create(source, i, search.Length);
 		}
 
-		/// <inheritdoc cref="First(string, Regex)"/>
 		/// <summary>
 		/// Finds the last instance of a pattern and returns a StringSegment for subsequent use.
 		/// </summary>
 		/// <remarks>If the pattern is right-to-left, then it will return the last segment from the right (first segment from the left).</remarks>
+		/// <inheritdoc cref="First(string, Regex)"/>
 		public static StringSegment Last(this string source, Regex pattern)
 		{
 			if (source is null) throw new ArgumentNullException(nameof(source));

Source/Extensions.Trim.cs

@@ -30,9 +30,9 @@ private static ReadOnlySpan<char> TrimStartPatternCore(ReadOnlySpan<char> source
 			return source;
 		}
 
-		/// <inheritdoc cref="TrimStartPattern(string, Regex)"/>
 		/// <param name="comparisonType">The comparison type to use when searching.  Default is ordinal.</param>
 		/// <param name="max">The maximum number of times to remove the specified sequence.  -1 (default) = all instances.</param>
+		/// <inheritdoc cref="TrimStartPattern(string, Regex)"/>
 		public static ReadOnlySpan<char> TrimStartPattern(this ReadOnlySpan<char> source,
 			in ReadOnlySpan<char> pattern,
 			StringComparison comparisonType = StringComparison.Ordinal,
@@ -59,8 +59,8 @@ public static ReadOnlySpan<char> TrimStartPattern(this ReadOnlySpan<char> source
 			return TrimStartPatternCore(source, pattern.AsSpan(), comparisonType, max);
 		}
 
-		/// <inheritdoc cref="TrimStartPattern(ReadOnlySpan{char}, in ReadOnlySpan{char}, StringComparison, int)"/>
 		/// <remarks>To any allocations, call .AsSpan() before calling this method name.</remarks>
+		/// <inheritdoc cref="TrimStartPattern(ReadOnlySpan{char}, in ReadOnlySpan{char}, StringComparison, int)"/>
 		public static string TrimStartPattern(this string source,
 			string pattern,
 			StringComparison comparisonType = StringComparison.Ordinal,
@@ -181,8 +181,8 @@ private static ReadOnlySpan<char> TrimEndPatternCore(ReadOnlySpan<char> source,
 			return source;
 		}
 
-		/// <inheritdoc cref="TrimEndPattern(string, Regex)"/>
 		/// <param name="comparisonType">The comparison type to use when searching.  Default is ordinal.</param>
+		/// <inheritdoc cref="TrimEndPattern(string, Regex, int)"/>
 		public static ReadOnlySpan<char> TrimEndPattern(this ReadOnlySpan<char> source,
 			in ReadOnlySpan<char> pattern,
 			StringComparison comparisonType = StringComparison.Ordinal,
@@ -211,8 +211,8 @@ public static ReadOnlySpan<char> TrimEndPattern(this ReadOnlySpan<char> source,
 			return TrimEndPatternCore(source, pattern.AsSpan(), comparisonType, max);
 		}
 
-		/// <inheritdoc cref="TrimEndPattern(ReadOnlySpan{char}, in ReadOnlySpan{char}, StringComparison, int)"/>
 		/// <remarks>To any allocations, call .AsSpan() before calling this method name.</remarks>
+		/// <inheritdoc cref="TrimEndPattern(ReadOnlySpan{char}, in ReadOnlySpan{char}, StringComparison, int)"/>
 		public static string TrimEndPattern(this string source,
 			string pattern,
 			StringComparison comparisonType = StringComparison.Ordinal,

Source/Open.Text.csproj

@@ -17,7 +17,7 @@
 		<RepositoryUrl>https://github.com/Open-NET-Libraries/Open.Text</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
 		<PackageTags>dotnet, dotnetcore, string, span, readonlyspan, text, format, split, trim, equals, trimmed equals, first, last, preceding, following, stringbuilder, extensions</PackageTags>
-		<Version>3.3.1</Version>
+		<Version>3.3.3</Version>
 		<PackageReleaseNotes></PackageReleaseNotes>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PublishRepositoryUrl>true</PublishRepositoryUrl>

Source/StringComparable.cs

@@ -86,10 +86,10 @@ public override int GetHashCode()
 
 	public static class StringComparableExtensions
 	{
-		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		/// <summary>
 		/// Prepares a string for a specific StringComparison.
 		/// </summary>
+		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		public static StringComparable AsComparable(this string source, StringComparison type)
 			=> new(source, type);
 
@@ -100,28 +100,27 @@ public static StringComparable AsComparable(this string source, StringComparison
 		public static StringComparable AsCaseInsensitive(this string source)
 			=> new(source, StringComparison.OrdinalIgnoreCase);
 
-		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		/// <summary>
 		/// Prepares a string to be invariant culture and case insensitive when comparing equality.
 		/// </summary>
+		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		public static StringComparable AsCaseInsensitiveInvariantCulture(this string source)
 			=> new(source, StringComparison.InvariantCultureIgnoreCase);
 
-		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		/// <summary>
 		/// Prepares a string to be invariant culture and case insensitive when comparing equality.
 		/// </summary>
+		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		public static StringComparable AsCaseInsensitiveCurrentCulture(this string source)
 			=> new(source, StringComparison.CurrentCultureIgnoreCase);
 
-		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		/// <summary>
 		/// Prepares a string to be current culture and case sensitive when comparing equality.
 		/// </summary>
+		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		public static StringComparable AsCurrentCulture(this string source)
 			=> new(source, StringComparison.CurrentCulture);
 
-		/// <inheritdoc cref="AsCaseInsensitive(string)"/>
 		/// <summary>
 		/// Prepares a string to be invariant culture and case sensitive when comparing equality.
 		/// </summary>

Source/StringSegment.cs

@@ -72,8 +72,8 @@ public StringSegment Preceding(bool includeSegment = false)
 		public StringSegment Following(bool includeSegment = false)
 			=> IsValid ? Create(Source, includeSegment ? Index : (Index + Length)) : default;
 
-		/// <inheritdoc cref="Preceding"/>
 		/// <param name="maxCharacters">The max number of characters to get.</param>
+		/// <inheritdoc cref="Preceding"/>
 		public StringSegment Preceding(int maxCharacters, bool includeSegment = false)
 		{
 			if (maxCharacters < 0) throw new ArgumentOutOfRangeException(nameof(maxCharacters), maxCharacters, "Must be at least zero.");
@@ -83,8 +83,8 @@ public StringSegment Preceding(int maxCharacters, bool includeSegment = false)
 			return new(Source, start, includeSegment ? (Index - start + Length) : (Index - start));
 		}
 
-		/// <inheritdoc cref="Following"/>
 		/// <param name="maxCharacters">The max number of characters to get.</param>
+		/// <inheritdoc cref="Following"/>
 		public StringSegment Following(int maxCharacters, bool includeSegment = false)
 		{
 			if (maxCharacters < 0) throw new ArgumentOutOfRangeException(nameof(maxCharacters), maxCharacters, "Must be at least zero.");