Skip to content

Commit cd21086

Browse files
committed
Fixed XML docs for internal helpers
1 parent 7738d34 commit cd21086

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Microsoft.Toolkit.HighPerformance/Memory/Internals/OverflowHelper.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ internal static class OverflowHelper
2121
/// <param name="width">The width of the 2D memory area to map.</param>
2222
/// <param name="pitch">The pitch of the 2D memory area to map (the distance between each row).</param>
2323
/// <exception cref="OverflowException">Throw when the inputs don't fit in the expected range.</exception>
24+
/// <remarks>The input parameters are assumed to always be positive.</remarks>
2425
[MethodImpl(MethodImplOptions.AggressiveInlining)]
2526
public static void EnsureIsInNativeIntRange(int height, int width, int pitch)
2627
{
@@ -53,13 +54,14 @@ public static void EnsureIsInNativeIntRange(int height, int width, int pitch)
5354
}
5455

5556
/// <summary>
56-
/// Ensures that the input parameters will not exceed the maximum native int value when indexing.
57+
/// Ensures that the input parameters will not exceed <see cref="int.MaxValue"/> when indexing.
5758
/// </summary>
5859
/// <param name="height">The height of the 2D memory area to map.</param>
5960
/// <param name="width">The width of the 2D memory area to map.</param>
6061
/// <param name="pitch">The pitch of the 2D memory area to map (the distance between each row).</param>
6162
/// <returns>The area resulting from the given parameters.</returns>
6263
/// <exception cref="OverflowException">Throw when the inputs don't fit in the expected range.</exception>
64+
/// <remarks>The input parameters are assumed to always be positive.</remarks>
6365
[Pure]
6466
[MethodImpl(MethodImplOptions.AggressiveInlining)]
6567
public static int ComputeInt32Area(int height, int width, int pitch)

0 commit comments

Comments
 (0)