Skip to content

Commit e4810fb

Browse files
author
DaZombieKiller
committed
Add XML documentation for index parameter on RefEnumerable indexers
1 parent efd1243 commit e4810fb

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

Microsoft.Toolkit.HighPerformance/Enumerables/ReadOnlyRefEnumerable{T}.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ public int Length
136136
/// <summary>
137137
/// Gets the element at the specified zero-based index.
138138
/// </summary>
139+
/// <param name="index">The zero-based index of the element.</param>
139140
/// <returns>A reference to the element at the specified index.</returns>
140141
/// <exception cref="IndexOutOfRangeException">
141142
/// Thrown when <paramref name="index"/> is invalid.
@@ -166,6 +167,7 @@ public ref readonly T this[int index]
166167
/// <summary>
167168
/// Gets the element at the specified zero-based index.
168169
/// </summary>
170+
/// <param name="index">The zero-based index of the element.</param>
169171
/// <returns>A reference to the element at the specified index.</returns>
170172
/// <exception cref="IndexOutOfRangeException">
171173
/// Thrown when <paramref name="index"/> is invalid.

Microsoft.Toolkit.HighPerformance/Enumerables/RefEnumerable{T}.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ public int Length
119119
/// <summary>
120120
/// Gets the element at the specified zero-based index.
121121
/// </summary>
122+
/// <param name="index">The zero-based index of the element.</param>
122123
/// <returns>A reference to the element at the specified index.</returns>
123124
/// <exception cref="IndexOutOfRangeException">
124125
/// Thrown when <paramref name="index"/> is invalid.
@@ -149,6 +150,7 @@ public ref T this[int index]
149150
/// <summary>
150151
/// Gets the element at the specified zero-based index.
151152
/// </summary>
153+
/// <param name="index">The zero-based index of the element.</param>
152154
/// <returns>A reference to the element at the specified index.</returns>
153155
/// <exception cref="IndexOutOfRangeException">
154156
/// Thrown when <paramref name="index"/> is invalid.

0 commit comments

Comments
 (0)