Merge pull request #17 from rameel/cleanup

- Remove unnecessary aggressive inlining
- Polish xml-comments

Author: rameel

Directory.Packages.props

@@ -7,7 +7,7 @@
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
     <PackageVersion Include="MinVer" Version="6.0.0" />
-    <PackageVersion Include="NUnit" Version="4.3.2" />
-    <PackageVersion Include="NUnit3TestAdapter" Version="5.0.0" />
+    <PackageVersion Include="NUnit" Version="4.4.0" />
+    <PackageVersion Include="NUnit3TestAdapter" Version="5.1.0" />
   </ItemGroup>
 </Project>

Ramstack.Structures/Collections/ArrayViewExtensions.cs

@@ -8,36 +8,38 @@ public static class ArrayViewExtensions
     /// <summary>
     /// Creates a new <see cref="ArrayView{T}"/> over an array.
     /// </summary>
+    /// <typeparam name="T">The type of elements in the array.</typeparam>
     /// <param name="value">The target array.</param>
     /// <returns>
-    /// An <see cref="ArrayView{T}"/> representing the array.
+    /// An <see cref="ArrayView{T}"/> representing the specified array.
     /// </returns>
-    [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static ArrayView<T> AsView<T>(this T[]? value) =>
         new(value ?? []);
 
     /// <summary>
-    /// Creates a new <see cref="ArrayView{T}"/> over a portion of the target array from a specified position to the end of the array.
+    /// Creates a new <see cref="ArrayView{T}"/> over a portion of the specified array,
+    /// starting at a specified position to the end of the array.
     /// </summary>
-    /// <param name="value">The target array.</param>
-    /// <param name="index">The index at which to begin the array view.</param>
+    /// <typeparam name="T">The type of elements in the array.</typeparam>
+    /// <param name="value">The array to create a view over.</param>
+    /// <param name="index">The zero-based starting position of the view in the array.</param>
     /// <returns>
-    /// An <see cref="ArrayView{T}"/> representing the array.
+    /// An <see cref="ArrayView{T}"/> representing the specified portion of the array.
     /// </returns>
-    [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static ArrayView<T> AsView<T>(this T[]? value, int index) =>
         new(value ?? [], index);
 
     /// <summary>
-    /// Creates a new <see cref="ArrayView{T}"/> over a portion of the target array from a specified position for a specified number of elements.
+    /// Creates a new <see cref="ArrayView{T}"/> over a portion of the specified array
+    /// starting at a specified position for a specified number of elements.
     /// </summary>
-    /// <param name="value">The target array.</param>
-    /// <param name="index">The index at which to begin the array view.</param>
-    /// <param name="count">The number of items in the array view.</param>
+    /// <typeparam name="T">The type of elements in the array.</typeparam>
+    /// <param name="value">The array to create a view over. Can be null.</param>
+    /// <param name="index">The zero-based starting position of the view in the array.</param>
+    /// <param name="count">The number of elements to include in the view.</param>
     /// <returns>
-    /// An <see cref="ArrayView{T}"/> representing the array.
+    /// An <see cref="ArrayView{T}"/> representing the specified portion of the array.
     /// </returns>
-    [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static ArrayView<T> AsView<T>(this T[]? value, int index, int count) =>
         new(value ?? [], index, count);
 

Ramstack.Structures/Collections/ArrayView`1.cs

@@ -59,7 +59,7 @@ public ArrayView(T[] array)
     /// a view for the specified range of the elements in the specified array.
     /// </summary>
     /// <param name="array">The array to wrap.</param>
-    /// <param name="index">The zero-based index of the first element in the range.</param>
+    /// <param name="index">The zero-based starting position of the view in the array.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public ArrayView(T[] array, int index)
     {
@@ -76,8 +76,8 @@ public ArrayView(T[] array, int index)
     /// a view for the specified range of the elements in the specified array.
     /// </summary>
     /// <param name="array">The array to wrap.</param>
-    /// <param name="index">The zero-based index of the first element in the range.</param>
-    /// <param name="length">The number of elements in the range.</param>
+    /// <param name="index">The zero-based starting position of the view in the array.</param>
+    /// <param name="length">The number of characters to include in the view.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public ArrayView(T[] array, int index, int length)
     {
@@ -108,9 +108,9 @@ public ArrayView(T[] array, int index, int length)
     /// <paramref name="length"/> are within bounds).
     /// </remarks>
     /// <param name="array">The array to wrap.</param>
-    /// <param name="index">The zero-based index of the first element in the range.</param>
-    /// <param name="length">The number of elements in the range.</param>
-    /// <param name="unused">Unused parameter, exists solely to disambiguate overloads.</param>
+    /// <param name="index">The zero-based starting position of the view in the array.</param>
+    /// <param name="length">The number of characters to include in the view.</param>
+    /// <param name="unused">Unused parameter used only to differentiate between overloads.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     internal ArrayView(T[] array, int index, int length, int unused)
     {

Ramstack.Structures/Internal/ThrowHelper.cs

@@ -1,11 +1,20 @@
 namespace Ramstack.Internal;
 
+/// <summary>
+/// Provides helper methods for throwing exceptions.
+/// </summary>
 internal static class ThrowHelper
 {
+    /// <summary>
+    /// Throws an <see cref="ArgumentOutOfRangeException"/>.
+    /// </summary>
     [DoesNotReturn]
     public static void ThrowArgumentOutOfRangeException() =>
         throw new ArgumentOutOfRangeException();
 
+    /// <summary>
+    /// Throws a <see cref="NotSupportedException"/>.
+    /// </summary>
     [DoesNotReturn]
     public static void ThrowNotSupportedException() =>
         throw new NotSupportedException();

Ramstack.Structures/Text/StringView.cs

@@ -54,7 +54,7 @@ public StringView(string value) : this(value, 0, value.Length, unused: 0)
     /// a view for the specified range of the characters in the specified string.
     /// </summary>
     /// <param name="value">The string to wrap.</param>
-    /// <param name="index">The zero-based index of the first character in the range.</param>
+    /// <param name="index">The zero-based starting position of the view in the string.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public StringView(string value, int index)
     {
@@ -71,8 +71,8 @@ public StringView(string value, int index)
     /// a view for the specified range of the characters in the specified string.
     /// </summary>
     /// <param name="value">The string to wrap.</param>
-    /// <param name="index">The zero-based index of the first character in the range.</param>
-    /// <param name="length">The number of characters in the range.</param>
+    /// <param name="index">The zero-based starting position of the view in the string.</param>
+    /// <param name="length">The number of characters to include in the view.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public StringView(string value, int index, int length)
     {
@@ -103,9 +103,9 @@ public StringView(string value, int index, int length)
     /// <paramref name="length"/> are within bounds).
     /// </remarks>
     /// <param name="value">The string to wrap.</param>
-    /// <param name="index">The zero-based index of the first character in the range.</param>
-    /// <param name="length">The number of characters in the range.</param>
-    /// <param name="unused">Unused parameter, exists solely to disambiguate overloads.</param>
+    /// <param name="index">The zero-based starting position of the view in the string.</param>
+    /// <param name="length">The number of characters to include in the view.</param>
+    /// <param name="unused">Unused parameter used only to differentiate between overloads.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     private StringView(string value, int index, int length, int unused)
     {

Ramstack.Structures/Text/StringViewComparer.cs

@@ -126,14 +126,14 @@ private sealed class CultureAwareComparer(CompareInfo info, CompareOptions optio
         #endif
     {
         /// <summary>
-        /// A singleton instance of the <see cref="T:CultureAwareComparer"/> class
+        /// A singleton instance of the <see cref="StringViewComparer.CultureAwareComparer"/> class
         /// for invariant case-sensitive comparison.
         /// </summary>
         public static readonly CultureAwareComparer InvariantInstance =
             new(CultureInfo.InvariantCulture.CompareInfo, CompareOptions.None);
 
         /// <summary>
-        /// A singleton instance of the <see cref="T:CultureAwareComparer"/> class
+        /// A singleton instance of the <see cref="StringViewComparer.CultureAwareComparer"/> class
         /// for invariant case-insensitive comparison.
         /// </summary>
         public static readonly CultureAwareComparer InvariantIgnoreCaseInstance =
@@ -180,7 +180,7 @@ private sealed class OrdinalComparer : StringViewComparer
         #endif
     {
         /// <summary>
-        /// A singleton instance of the <see cref="T:OrdinalComparer"/> class.
+        /// A singleton instance of the <see cref="StringViewComparer.OrdinalComparer"/> class.
         /// </summary>
         public static readonly OrdinalComparer Instance = new();
 
@@ -225,7 +225,7 @@ private sealed class OrdinalIgnoreCaseComparer : StringViewComparer
         #endif
     {
         /// <summary>
-        /// A singleton instance of the <see cref="T:OrdinalIgnoreCaseComparer"/> class.
+        /// A singleton instance of the <see cref="StringViewComparer.OrdinalIgnoreCaseComparer"/> class.
         /// </summary>
         public static readonly OrdinalIgnoreCaseComparer Instance = new();
 

Ramstack.Structures/Text/StringViewExtensions.cs

@@ -8,34 +8,34 @@ public static class StringViewExtensions
     /// <summary>
     /// Creates a new <see cref="StringView"/> over a string.
     /// </summary>
-    /// <param name="value">The target string.</param>
+    /// <param name="value">The string to create a view over.</param>
     /// <returns>
-    /// The read-only view representation of the string.
+    /// A <see cref="StringView"/> representing the specified string.
     /// </returns>
     public static StringView AsView(this string? value) =>
         new(value ?? "");
 
     /// <summary>
-    /// Creates a new <see cref="StringView"/> over a portion of the target string
-    /// from a specified position to the end of the string.
+    /// Creates a new <see cref="StringView"/> over a portion of the specified string
+    /// starting at a specified position to the end of the string.
     /// </summary>
-    /// <param name="value">The target string.</param>
-    /// <param name="index">The index at which to begin this slice.</param>
+    /// <param name="value">The string to create a view over.</param>
+    /// <param name="index">The zero-based starting position of the view in the string.</param>
     /// <returns>
-    /// The read-only view representation of the string.
+    /// A <see cref="StringView"/> representing the specified portion of the string.
     /// </returns>
     public static StringView AsView(this string? value, int index) =>
         new(value ?? "", index);
 
     /// <summary>
-    /// Creates a new <see cref="StringView"/> over a portion of the target string
-    /// from a specified position for a specified number of characters.
+    /// Creates a new <see cref="StringView"/> over a portion of the specified string
+    /// starting at a specified position for a specified number of characters.
     /// </summary>
-    /// <param name="value">The target string.</param>
-    /// <param name="index">The index at which to begin this slice.</param>
-    /// <param name="length">The desired length for the slice.</param>
+    /// <param name="value">The string to create a view over.</param>
+    /// <param name="index">The zero-based starting position of the view in the string.</param>
+    /// <param name="length">The number of characters to include in the view.</param>
     /// <returns>
-    /// The read-only view representation of the string.
+    /// A <see cref="StringView"/> representing the specified portion of the string.
     /// </returns>
     public static StringView AsView(this string? value, int index, int length) =>
         new(value ?? "", index, length);