From e82ea2c6b7a27242e0fcd6f86944f15c27176d8c Mon Sep 17 00:00:00 2001 From: James Jackson-South Date: Tue, 6 Dec 2016 00:10:39 +1100 Subject: [PATCH] Add documentation to PixelAccessor --- src/ImageSharp/Image/PixelAccessor.cs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/ImageSharp/Image/PixelAccessor.cs b/src/ImageSharp/Image/PixelAccessor.cs index 39534dbdec..f11082df71 100644 --- a/src/ImageSharp/Image/PixelAccessor.cs +++ b/src/ImageSharp/Image/PixelAccessor.cs @@ -420,6 +420,14 @@ namespace ImageSharp return this.pixelsBase + ((targetY * this.Width) * Unsafe.SizeOf()); } + /// + /// Checks the coordinates to ensure they are within bounds. + /// + /// The x-coordinate of the pixel. Must be greater than zero and smaller than the width of the pixel. + /// The y-coordinate of the pixel. Must be greater than zero and smaller than the width of the pixel. + /// + /// Thrown if the coordinates are not within the bounds of the image. + /// [Conditional("DEBUG")] private void CheckCoordinates(int x, int y) {