Skip to content

Commit b467571

Browse files
committed
Correct exception types in ThrowHelper XML docs
Updated XML documentation in ThrowHelper to accurately reflect the actual exception types thrown by helper methods. This improves documentation clarity and correctness for ArgumentOutOfRangeException and InvalidOperationException cases.
1 parent a8b2f88 commit b467571

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

Source/Src/KZDev.PerfUtils/Helpers/ThrowHelper.cs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ internal static void ThrowArgumentOutOfRangeException_CapacitySmall (string argu
236236
/// Throws an argument out of range exception with the message indicating that the
237237
/// stream length would be invalid.
238238
/// </summary>
239-
/// <exception cref="IOException">
239+
/// <exception cref="ArgumentOutOfRangeException">
240240
/// </exception>
241241
[DoesNotReturn]
242242
internal static void ThrowArgumentOutOfRangeException_StreamLength (string argumentName) =>
@@ -246,7 +246,7 @@ internal static void ThrowArgumentOutOfRangeException_StreamLength (string argum
246246
/// Throws an argument out of range exception with the message indicating that the
247247
/// stream length would be invalid.
248248
/// </summary>
249-
/// <exception cref="IOException">
249+
/// <exception cref="ArgumentOutOfRangeException">
250250
/// </exception>
251251
[DoesNotReturn]
252252
internal static void ThrowArgumentOutOfRangeException_TooLargeForArray(string argumentName) =>
@@ -275,7 +275,8 @@ internal static void ThrowIOException_SeekBeforeBegin () =>
275275
/// Throws an invalid operation exception with the message for an integer overflow
276276
/// when calculating the new capacity or accessing the Int32 Capacity property of a stream.
277277
/// </summary>
278-
/// <exception cref="ArgumentOutOfRangeException"></exception>
278+
/// <exception cref="InvalidOperationException">
279+
/// </exception>
279280
[DoesNotReturn]
280281
internal static void ThrowInvalidOperationException_IntOverflowCapacity () =>
281282
throw new InvalidOperationException(Strings.InvalidOperation_IntOverflowCapacity);
@@ -284,7 +285,8 @@ internal static void ThrowInvalidOperationException_IntOverflowCapacity () =>
284285
/// Throws an invalid operation exception with the message for an attempt to copy
285286
/// the stream into an array but the length of the stream is too large to fit in an array.
286287
/// </summary>
287-
/// <exception cref="NotImplementedException"></exception>
288+
/// <exception cref="InvalidOperationException">
289+
/// </exception>
288290
[DoesNotReturn]
289291
internal static void ThrowInvalidOperationException_TooLargeToCopyToArray () =>
290292
throw new InvalidOperationException (Strings.InvalidOperation_TooLargeToCopyToArray);

0 commit comments

Comments
 (0)