Normalize parameter documentation across all extension methods

src/ImageSharp/Processing/AdaptiveThresholdExtensions.cs

@@ -13,61 +13,61 @@ public static class AdaptiveThresholdExtensions
     /// <summary>
     /// Applies Bradley Adaptive Threshold to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
-    /// <returns>The <see cref="Image{TPixel}"/>.</returns>
+    /// <param name="source">The current image processing context.</param>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source)
         => source.ApplyProcessor(new AdaptiveThresholdProcessor());
 
     /// <summary>
     /// Applies Bradley Adaptive Threshold to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="thresholdLimit">Threshold limit (0.0-1.0) to consider for binarization.</param>
-    /// <returns>The <see cref="Image{TPixel}"/>.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, float thresholdLimit)
         => source.ApplyProcessor(new AdaptiveThresholdProcessor(thresholdLimit));
 
     /// <summary>
     /// Applies Bradley Adaptive Threshold to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="upper">Upper (white) color for thresholding.</param>
     /// <param name="lower">Lower (black) color for thresholding.</param>
-    /// <returns>The <see cref="Image{TPixel}"/>.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, Color upper, Color lower)
         => source.ApplyProcessor(new AdaptiveThresholdProcessor(upper, lower));
 
     /// <summary>
     /// Applies Bradley Adaptive Threshold to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="upper">Upper (white) color for thresholding.</param>
     /// <param name="lower">Lower (black) color for thresholding.</param>
     /// <param name="thresholdLimit">Threshold limit (0.0-1.0) to consider for binarization.</param>
-    /// <returns>The <see cref="Image{TPixel}"/>.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, Color upper, Color lower, float thresholdLimit)
         => source.ApplyProcessor(new AdaptiveThresholdProcessor(upper, lower, thresholdLimit));
 
     /// <summary>
     /// Applies Bradley Adaptive Threshold to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="upper">Upper (white) color for thresholding.</param>
     /// <param name="lower">Lower (black) color for thresholding.</param>
     /// <param name="rectangle">Rectangle region to apply the processor on.</param>
-    /// <returns>The <see cref="Image{TPixel}"/>.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, Color upper, Color lower, Rectangle rectangle)
         => source.ApplyProcessor(new AdaptiveThresholdProcessor(upper, lower), rectangle);
 
     /// <summary>
     /// Applies Bradley Adaptive Threshold to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="upper">Upper (white) color for thresholding.</param>
     /// <param name="lower">Lower (black) color for thresholding.</param>
     /// <param name="thresholdLimit">Threshold limit (0.0-1.0) to consider for binarization.</param>
     /// <param name="rectangle">Rectangle region to apply the processor on.</param>
-    /// <returns>The <see cref="Image{TPixel}"/>.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext AdaptiveThreshold(this IImageProcessingContext source, Color upper, Color lower, float thresholdLimit, Rectangle rectangle)
         => source.ApplyProcessor(new AdaptiveThresholdProcessor(upper, lower, thresholdLimit), rectangle);
 }

src/ImageSharp/Processing/Extensions/Binarization/BinaryDitherExtensions.cs

@@ -14,21 +14,21 @@ public static class BinaryDitherExtensions
     /// <summary>
     /// Dithers the image reducing it to two colors using ordered dithering.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="dither">The ordered ditherer.</param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext
         BinaryDither(this IImageProcessingContext source, IDither dither) =>
         BinaryDither(source, dither, Color.White, Color.Black);
 
     /// <summary>
     /// Dithers the image reducing it to two colors using ordered dithering.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="dither">The ordered ditherer.</param>
     /// <param name="upperColor">The color to use for pixels that are above the threshold.</param>
     /// <param name="lowerColor">The color to use for pixels that are below the threshold</param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryDither(
         this IImageProcessingContext source,
         IDither dither,
@@ -39,12 +39,12 @@ public static IImageProcessingContext BinaryDither(
     /// <summary>
     /// Dithers the image reducing it to two colors using ordered dithering.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="dither">The ordered ditherer.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryDither(
         this IImageProcessingContext source,
         IDither dither,
@@ -54,14 +54,14 @@ public static IImageProcessingContext BinaryDither(
     /// <summary>
     /// Dithers the image reducing it to two colors using ordered dithering.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="dither">The ordered ditherer.</param>
     /// <param name="upperColor">The color to use for pixels that are above the threshold.</param>
     /// <param name="lowerColor">The color to use for pixels that are below the threshold</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryDither(
         this IImageProcessingContext source,
         IDither dither,

src/ImageSharp/Processing/Extensions/Binarization/BinaryThresholdExtensions.cs

@@ -15,19 +15,19 @@ public static class BinaryThresholdExtensions
     /// Applies binarization to the image splitting the pixels at the given threshold with
     /// Luminance as the color component to be compared to threshold.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="threshold">The threshold to apply binarization of the image. Must be between 0 and 1.</param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryThreshold(this IImageProcessingContext source, float threshold)
         => source.ApplyProcessor(new BinaryThresholdProcessor(threshold, BinaryThresholdMode.Luminance));
 
     /// <summary>
     /// Applies binarization to the image splitting the pixels at the given threshold.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="threshold">The threshold to apply binarization of the image. Must be between 0 and 1.</param>
     /// <param name="mode">Selects the value to be compared to threshold.</param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryThreshold(
         this IImageProcessingContext source,
         float threshold,
@@ -38,12 +38,12 @@ public static IImageProcessingContext BinaryThreshold(
     /// Applies binarization to the image splitting the pixels at the given threshold with
     /// Luminance as the color component to be compared to threshold.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="threshold">The threshold to apply binarization of the image. Must be between 0 and 1.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryThreshold(
         this IImageProcessingContext source,
         float threshold,
@@ -53,13 +53,13 @@ public static IImageProcessingContext BinaryThreshold(
     /// <summary>
     /// Applies binarization to the image splitting the pixels at the given threshold.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="threshold">The threshold to apply binarization of the image. Must be between 0 and 1.</param>
     /// <param name="mode">Selects the value to be compared to threshold.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryThreshold(
         this IImageProcessingContext source,
         float threshold,
@@ -71,11 +71,11 @@ public static IImageProcessingContext BinaryThreshold(
     /// Applies binarization to the image splitting the pixels at the given threshold with
     /// Luminance as the color component to be compared to threshold.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="threshold">The threshold to apply binarization of the image. Must be between 0 and 1.</param>
     /// <param name="upperColor">The color to use for pixels that are above the threshold.</param>
     /// <param name="lowerColor">The color to use for pixels that are below the threshold</param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryThreshold(
         this IImageProcessingContext source,
         float threshold,
@@ -86,12 +86,12 @@ public static IImageProcessingContext BinaryThreshold(
     /// <summary>
     /// Applies binarization to the image splitting the pixels at the given threshold.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="threshold">The threshold to apply binarization of the image. Must be between 0 and 1.</param>
     /// <param name="upperColor">The color to use for pixels that are above the threshold.</param>
     /// <param name="lowerColor">The color to use for pixels that are below the threshold</param>
     /// <param name="mode">Selects the value to be compared to threshold.</param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryThreshold(
         this IImageProcessingContext source,
         float threshold,
@@ -104,14 +104,14 @@ public static IImageProcessingContext BinaryThreshold(
     /// Applies binarization to the image splitting the pixels at the given threshold with
     /// Luminance as the color component to be compared to threshold.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="threshold">The threshold to apply binarization of the image. Must be between 0 and 1.</param>
     /// <param name="upperColor">The color to use for pixels that are above the threshold.</param>
     /// <param name="lowerColor">The color to use for pixels that are below the threshold</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryThreshold(
         this IImageProcessingContext source,
         float threshold,
@@ -123,15 +123,15 @@ public static IImageProcessingContext BinaryThreshold(
     /// <summary>
     /// Applies binarization to the image splitting the pixels at the given threshold.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="threshold">The threshold to apply binarization of the image. Must be between 0 and 1.</param>
     /// <param name="upperColor">The color to use for pixels that are above the threshold.</param>
     /// <param name="lowerColor">The color to use for pixels that are below the threshold</param>
     /// <param name="mode">Selects the value to be compared to threshold.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BinaryThreshold(
         this IImageProcessingContext source,
         float threshold,

src/ImageSharp/Processing/Extensions/Convolution/BokehBlurExtensions.cs

@@ -13,44 +13,44 @@ public static class BokehBlurExtensions
     /// <summary>
     /// Applies a bokeh blur to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <param name="source">The current image processing context.</param>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BokehBlur(this IImageProcessingContext source)
         => source.ApplyProcessor(new BokehBlurProcessor());
 
     /// <summary>
     /// Applies a bokeh blur to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="radius">The 'radius' value representing the size of the area to sample.</param>
     /// <param name="components">The 'components' value representing the number of kernels to use to approximate the bokeh effect.</param>
     /// <param name="gamma">The gamma highlight factor to use to emphasize bright spots in the source image</param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BokehBlur(this IImageProcessingContext source, int radius, int components, float gamma)
         => source.ApplyProcessor(new BokehBlurProcessor(radius, components, gamma));
 
     /// <summary>
     /// Applies a bokeh blur to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BokehBlur(this IImageProcessingContext source, Rectangle rectangle)
         => source.ApplyProcessor(new BokehBlurProcessor(), rectangle);
 
     /// <summary>
     /// Applies a bokeh blur to the image.
     /// </summary>
-    /// <param name="source">The image this method extends.</param>
+    /// <param name="source">The current image processing context.</param>
     /// <param name="radius">The 'radius' value representing the size of the area to sample.</param>
     /// <param name="components">The 'components' value representing the number of kernels to use to approximate the bokeh effect.</param>
     /// <param name="gamma">The gamma highlight factor to use to emphasize bright spots in the source image</param>
     /// <param name="rectangle">
     /// The <see cref="Rectangle"/> structure that specifies the portion of the image object to alter.
     /// </param>
-    /// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
+    /// <returns>The <see cref="IImageProcessingContext"/>.</returns>
     public static IImageProcessingContext BokehBlur(this IImageProcessingContext source, int radius, int components, float gamma, Rectangle rectangle)
         => source.ApplyProcessor(new BokehBlurProcessor(radius, components, gamma), rectangle);
 }