Refine xml-comments

Author: rameel

Ramstack.Structures/Collections/ArrayViewExtensions.cs

@@ -8,32 +8,37 @@ 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>
     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>
     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>
     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)
     {