From b471a0cfbafc7ec4a02936cb777424e8f7b44fc2 Mon Sep 17 00:00:00 2001 From: Scott Williams Date: Fri, 3 Feb 2017 10:21:50 +0000 Subject: [PATCH] xml doc fixes --- src/ImageSharp.Drawing.Paths/DrawBeziers.cs | 30 ++++++------- src/ImageSharp.Drawing.Paths/DrawLines.cs | 30 ++++++------- src/ImageSharp.Drawing.Paths/DrawPath.cs | 36 ++++++---------- src/ImageSharp.Drawing.Paths/DrawPolygon.cs | 32 ++++++-------- src/ImageSharp.Drawing.Paths/DrawRectangle.cs | 30 ++++++------- src/ImageSharp.Drawing.Paths/DrawShape.cs | 30 ++++++------- src/ImageSharp.Drawing.Paths/FillPaths.cs | 24 ++++------- src/ImageSharp.Drawing.Paths/FillPolygon.cs | 20 ++++----- src/ImageSharp.Drawing.Paths/FillRectangle.cs | 20 ++++----- src/ImageSharp.Drawing.Paths/FillShape.cs | 20 ++++----- .../PointInfoExtensions.cs | 2 +- .../RectangleExtensions.cs | 2 +- src/ImageSharp.Drawing.Paths/ShapePath.cs | 43 +++---------------- src/ImageSharp.Drawing.Paths/ShapeRegion.cs | 36 ++-------------- src/ImageSharp.Drawing/DrawPath.cs | 36 ++++++---------- src/ImageSharp.Drawing/Drawable.cs | 6 --- src/ImageSharp.Drawing/FillRegion.cs | 18 ++++---- .../Processors/DrawPathProcessor.cs | 10 ++--- .../Processors/FillRegionProcessor.cs | 6 +-- src/ImageSharp.Drawing/Region.cs | 13 +++--- 20 files changed, 149 insertions(+), 295 deletions(-) diff --git a/src/ImageSharp.Drawing.Paths/DrawBeziers.cs b/src/ImageSharp.Drawing.Paths/DrawBeziers.cs index 6515db577..1a511d84d 100644 --- a/src/ImageSharp.Drawing.Paths/DrawBeziers.cs +++ b/src/ImageSharp.Drawing.Paths/DrawBeziers.cs @@ -24,14 +24,12 @@ namespace ImageSharp /// Draws the provided Points as an open Bezier path at the provided thickness with the supplied brush /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image DrawBeziers(this Image source, IBrush brush, float thickness, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -42,11 +40,11 @@ namespace ImageSharp /// Draws the provided Points as an open Bezier path at the provided thickness with the supplied brush /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The points. - /// The Image + /// The . public static Image DrawBeziers(this Image source, IBrush brush, float thickness, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { @@ -57,11 +55,11 @@ namespace ImageSharp /// Draws the provided Points as an open Bezier path at the provided thickness with the supplied brush /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The points. - /// The Image + /// The . public static Image DrawBeziers(this Image source, TColor color, float thickness, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { @@ -72,14 +70,12 @@ namespace ImageSharp /// Draws the provided Points as an open Bezier path at the provided thickness with the supplied brush /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image DrawBeziers(this Image source, TColor color, float thickness, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -90,13 +86,11 @@ namespace ImageSharp /// Draws the provided Points as an open Bezier path with the supplied pen /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image DrawBeziers(this Image source, IPen pen, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -107,10 +101,10 @@ namespace ImageSharp /// Draws the provided Points as an open Bezier path with the supplied pen /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The points. - /// The Image + /// The . public static Image DrawBeziers(this Image source, IPen pen, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/DrawLines.cs b/src/ImageSharp.Drawing.Paths/DrawLines.cs index 1ff58fd1d..f6f8d8f6c 100644 --- a/src/ImageSharp.Drawing.Paths/DrawLines.cs +++ b/src/ImageSharp.Drawing.Paths/DrawLines.cs @@ -22,14 +22,12 @@ namespace ImageSharp /// Draws the provided Points as an open Linear path at the provided thickness with the supplied brush /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image DrawLines(this Image source, IBrush brush, float thickness, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -40,11 +38,11 @@ namespace ImageSharp /// Draws the provided Points as an open Linear path at the provided thickness with the supplied brush /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The points. - /// The Image + /// The . public static Image DrawLines(this Image source, IBrush brush, float thickness, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { @@ -55,11 +53,11 @@ namespace ImageSharp /// Draws the provided Points as an open Linear path at the provided thickness with the supplied brush /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The points. - /// The Image + /// The . public static Image DrawLines(this Image source, TColor color, float thickness, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { @@ -70,14 +68,12 @@ namespace ImageSharp /// Draws the provided Points as an open Linear path at the provided thickness with the supplied brush /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The points. /// The options. - /// - /// The Image - /// + /// The .> public static Image DrawLines(this Image source, TColor color, float thickness, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -88,13 +84,11 @@ namespace ImageSharp /// Draws the provided Points as an open Linear path with the supplied pen /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image DrawLines(this Image source, IPen pen, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -105,10 +99,10 @@ namespace ImageSharp /// Draws the provided Points as an open Linear path with the supplied pen /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The points. - /// The Image + /// The . public static Image DrawLines(this Image source, IPen pen, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/DrawPath.cs b/src/ImageSharp.Drawing.Paths/DrawPath.cs index 201984e0a..4e4275df6 100644 --- a/src/ImageSharp.Drawing.Paths/DrawPath.cs +++ b/src/ImageSharp.Drawing.Paths/DrawPath.cs @@ -22,13 +22,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The path. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IPen pen, IPath path, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -39,12 +37,10 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The path. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IPen pen, IPath path) where TColor : struct, IPackedPixel, IEquatable { @@ -55,14 +51,12 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IBrush brush, float thickness, IPath path, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -73,13 +67,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The path. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IBrush brush, float thickness, IPath path) where TColor : struct, IPackedPixel, IEquatable { @@ -90,14 +82,12 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The path. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, TColor color, float thickness, IPath path, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -108,13 +98,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The path. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, TColor color, float thickness, IPath path) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/DrawPolygon.cs b/src/ImageSharp.Drawing.Paths/DrawPolygon.cs index 571b13c1e..28785e5cb 100644 --- a/src/ImageSharp.Drawing.Paths/DrawPolygon.cs +++ b/src/ImageSharp.Drawing.Paths/DrawPolygon.cs @@ -22,14 +22,12 @@ namespace ImageSharp /// Draws the provided Points as a closed Linear Polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image DrawPolygon(this Image source, IBrush brush, float thickness, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -40,11 +38,11 @@ namespace ImageSharp /// Draws the provided Points as a closed Linear Polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The points. - /// The Image + /// The . public static Image DrawPolygon(this Image source, IBrush brush, float thickness, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { @@ -55,11 +53,11 @@ namespace ImageSharp /// Draws the provided Points as a closed Linear Polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The points. - /// The Image + /// The . public static Image DrawPolygon(this Image source, TColor color, float thickness, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { @@ -70,14 +68,12 @@ namespace ImageSharp /// Draws the provided Points as a closed Linear Polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image DrawPolygon(this Image source, TColor color, float thickness, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -88,12 +84,10 @@ namespace ImageSharp /// Draws the provided Points as a closed Linear Polygon with the provided Pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The points. - /// - /// The Image - /// + /// The . public static Image DrawPolygon(this Image source, IPen pen, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { @@ -104,13 +98,11 @@ namespace ImageSharp /// Draws the provided Points as a closed Linear Polygon with the provided Pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image DrawPolygon(this Image source, IPen pen, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/DrawRectangle.cs b/src/ImageSharp.Drawing.Paths/DrawRectangle.cs index 28ea3d6e0..4e8ec7135 100644 --- a/src/ImageSharp.Drawing.Paths/DrawRectangle.cs +++ b/src/ImageSharp.Drawing.Paths/DrawRectangle.cs @@ -23,13 +23,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IPen pen, Rectangle shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -40,10 +38,10 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The shape. - /// The Image + /// The . public static Image Draw(this Image source, IPen pen, Rectangle shape) where TColor : struct, IPackedPixel, IEquatable { @@ -54,14 +52,12 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IBrush brush, float thickness, Rectangle shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -72,11 +68,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The shape. - /// The Image + /// The . public static Image Draw(this Image source, IBrush brush, float thickness, Rectangle shape) where TColor : struct, IPackedPixel, IEquatable { @@ -87,14 +83,12 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, TColor color, float thickness, Rectangle shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -105,11 +99,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The shape. - /// The Image + /// The . public static Image Draw(this Image source, TColor color, float thickness, Rectangle shape) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/DrawShape.cs b/src/ImageSharp.Drawing.Paths/DrawShape.cs index 15ae2b179..6ddce65b9 100644 --- a/src/ImageSharp.Drawing.Paths/DrawShape.cs +++ b/src/ImageSharp.Drawing.Paths/DrawShape.cs @@ -22,13 +22,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IPen pen, IShape shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -39,10 +37,10 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The shape. - /// The Image + /// The . public static Image Draw(this Image source, IPen pen, IShape shape) where TColor : struct, IPackedPixel, IEquatable { @@ -53,14 +51,12 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IBrush brush, float thickness, IShape shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -71,11 +67,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The shape. - /// The Image + /// The . public static Image Draw(this Image source, IBrush brush, float thickness, IShape shape) where TColor : struct, IPackedPixel, IEquatable { @@ -86,14 +82,12 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, TColor color, float thickness, IShape shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -104,11 +98,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The shape. - /// The Image + /// The . public static Image Draw(this Image source, TColor color, float thickness, IShape shape) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/FillPaths.cs b/src/ImageSharp.Drawing.Paths/FillPaths.cs index 3095ee7cd..09a799794 100644 --- a/src/ImageSharp.Drawing.Paths/FillPaths.cs +++ b/src/ImageSharp.Drawing.Paths/FillPaths.cs @@ -22,13 +22,11 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The shape. /// The graphics options. - /// - /// The Image - /// + /// The . public static Image Fill(this Image source, IBrush brush, IPath path, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -39,12 +37,10 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The path. - /// - /// The Image - /// + /// The . public static Image Fill(this Image source, IBrush brush, IPath path) where TColor : struct, IPackedPixel, IEquatable { @@ -55,13 +51,11 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The path. /// The options. - /// - /// The Image - /// + /// The . public static Image Fill(this Image source, TColor color, IPath path, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -72,12 +66,10 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The path. - /// - /// The Image - /// + /// The . public static Image Fill(this Image source, TColor color, IPath path) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/FillPolygon.cs b/src/ImageSharp.Drawing.Paths/FillPolygon.cs index 4092e5fc6..a609ceed2 100644 --- a/src/ImageSharp.Drawing.Paths/FillPolygon.cs +++ b/src/ImageSharp.Drawing.Paths/FillPolygon.cs @@ -22,13 +22,11 @@ namespace ImageSharp /// Flood fills the image in the shape of a Linear polygon described by the points /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image FillPolygon(this Image source, IBrush brush, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -39,10 +37,10 @@ namespace ImageSharp /// Flood fills the image in the shape of a Linear polygon described by the points /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The points. - /// The Image + /// The . public static Image FillPolygon(this Image source, IBrush brush, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { @@ -53,13 +51,11 @@ namespace ImageSharp /// Flood fills the image in the shape of a Linear polygon described by the points /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The points. /// The options. - /// - /// The Image - /// + /// The . public static Image FillPolygon(this Image source, TColor color, Vector2[] points, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -70,10 +66,10 @@ namespace ImageSharp /// Flood fills the image in the shape of a Linear polygon described by the points /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The points. - /// The Image + /// The . public static Image FillPolygon(this Image source, TColor color, Vector2[] points) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/FillRectangle.cs b/src/ImageSharp.Drawing.Paths/FillRectangle.cs index aef777edd..579a288a4 100644 --- a/src/ImageSharp.Drawing.Paths/FillRectangle.cs +++ b/src/ImageSharp.Drawing.Paths/FillRectangle.cs @@ -20,13 +20,11 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Fill(this Image source, IBrush brush, Rectangle shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -37,10 +35,10 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The shape. - /// The Image + /// The . public static Image Fill(this Image source, IBrush brush, Rectangle shape) where TColor : struct, IPackedPixel, IEquatable { @@ -51,13 +49,11 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Fill(this Image source, TColor color, Rectangle shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -68,10 +64,10 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The shape. - /// The Image + /// The . public static Image Fill(this Image source, TColor color, Rectangle shape) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/FillShape.cs b/src/ImageSharp.Drawing.Paths/FillShape.cs index 6e50f7377..52a3c60dd 100644 --- a/src/ImageSharp.Drawing.Paths/FillShape.cs +++ b/src/ImageSharp.Drawing.Paths/FillShape.cs @@ -22,13 +22,11 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The shape. /// The graphics options. - /// - /// The Image - /// + /// The . public static Image Fill(this Image source, IBrush brush, IShape shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -39,10 +37,10 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The shape. - /// The Image + /// The . public static Image Fill(this Image source, IBrush brush, IShape shape) where TColor : struct, IPackedPixel, IEquatable { @@ -53,13 +51,11 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The shape. /// The options. - /// - /// The Image - /// + /// The . public static Image Fill(this Image source, TColor color, IShape shape, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -70,10 +66,10 @@ namespace ImageSharp /// Flood fills the image in the shape of the provided polygon with the specified brush.. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The shape. - /// The Image + /// The . public static Image Fill(this Image source, TColor color, IShape shape) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing.Paths/PointInfoExtensions.cs b/src/ImageSharp.Drawing.Paths/PointInfoExtensions.cs index ea38dfb9d..18cd4e66c 100644 --- a/src/ImageSharp.Drawing.Paths/PointInfoExtensions.cs +++ b/src/ImageSharp.Drawing.Paths/PointInfoExtensions.cs @@ -13,7 +13,7 @@ namespace ImageSharp.Drawing /// /// Converts a to an ImageSharp . /// - /// The source. + /// The image this method extends. /// A representation of this public static PointInfo Convert(this SixLabors.Shapes.PointInfo source) { diff --git a/src/ImageSharp.Drawing.Paths/RectangleExtensions.cs b/src/ImageSharp.Drawing.Paths/RectangleExtensions.cs index 8369cc83f..1faa6469a 100644 --- a/src/ImageSharp.Drawing.Paths/RectangleExtensions.cs +++ b/src/ImageSharp.Drawing.Paths/RectangleExtensions.cs @@ -22,7 +22,7 @@ namespace ImageSharp.Drawing.Processors /// /// Converts a Shaper2D to an ImageSharp by creating a the entirely surrounds the source. /// - /// The source. + /// The image this method extends. /// A representation of this public static Rectangle Convert(this SixLabors.Shapes.Rectangle source) { diff --git a/src/ImageSharp.Drawing.Paths/ShapePath.cs b/src/ImageSharp.Drawing.Paths/ShapePath.cs index ee1f6e9d9..f2f07ea3c 100644 --- a/src/ImageSharp.Drawing.Paths/ShapePath.cs +++ b/src/ImageSharp.Drawing.Paths/ShapePath.cs @@ -64,32 +64,13 @@ namespace ImageSharp.Drawing /// public ImmutableArray Paths { get; } - /// - /// Gets the maximum number of intersections to could be returned. - /// - /// - /// The maximum intersections. - /// + /// public override int MaxIntersections => this.shape.MaxIntersections; - /// - /// Gets the bounds. - /// - /// - /// The bounds. - /// + /// public override Rectangle Bounds { get; } - /// - /// Scans the X axis for intersections. - /// - /// The x. - /// The buffer. - /// The length. - /// The offset. - /// - /// The number of intersections found. - /// + /// public override int ScanX(int x, float[] buffer, int length, int offset) { Vector2 start = new Vector2(x, this.Bounds.Top - 1); @@ -117,16 +98,7 @@ namespace ImageSharp.Drawing } } - /// - /// Scans the Y axis for intersections. - /// - /// The position along the y axis to find intersections. - /// The buffer. - /// The length. - /// The offset. - /// - /// The number of intersections found. - /// + /// public override int ScanY(int y, float[] buffer, int length, int offset) { Vector2 start = new Vector2(float.MinValue, y); @@ -154,12 +126,7 @@ namespace ImageSharp.Drawing } } - /// - /// Gets the point information for the specified x and y location. - /// - /// The x. - /// The y. - /// Information about the the point + /// public override PointInfo GetPointInfo(int x, int y) { Vector2 point = new Vector2(x, y); diff --git a/src/ImageSharp.Drawing.Paths/ShapeRegion.cs b/src/ImageSharp.Drawing.Paths/ShapeRegion.cs index b6921f16e..a1fdd7b8c 100644 --- a/src/ImageSharp.Drawing.Paths/ShapeRegion.cs +++ b/src/ImageSharp.Drawing.Paths/ShapeRegion.cs @@ -44,32 +44,13 @@ namespace ImageSharp.Drawing /// public IShape Shape { get; } - /// - /// Gets the maximum number of intersections to could be returned. - /// - /// - /// The maximum intersections. - /// + /// public override int MaxIntersections => this.Shape.MaxIntersections; - /// - /// Gets the bounds. - /// - /// - /// The bounds. - /// + /// public override Rectangle Bounds { get; } - /// - /// Scans the X axis for intersections. - /// - /// The x. - /// The buffer. - /// The length. - /// The offset. - /// - /// The number of intersections found. - /// + /// public override int ScanX(int x, float[] buffer, int length, int offset) { Vector2 start = new Vector2(x, this.Bounds.Top - 1); @@ -97,16 +78,7 @@ namespace ImageSharp.Drawing } } - /// - /// Scans the Y axis for intersections. - /// - /// The position along the y axis to find intersections. - /// The buffer. - /// The length. - /// The offset. - /// - /// The number of intersections found. - /// + /// public override int ScanY(int y, float[] buffer, int length, int offset) { Vector2 start = new Vector2(float.MinValue, y); diff --git a/src/ImageSharp.Drawing/DrawPath.cs b/src/ImageSharp.Drawing/DrawPath.cs index fe833e3af..d92731270 100644 --- a/src/ImageSharp.Drawing/DrawPath.cs +++ b/src/ImageSharp.Drawing/DrawPath.cs @@ -21,13 +21,11 @@ namespace ImageSharp /// Draws the outline of the region with the provided pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The path. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IPen pen, Drawable path, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -38,12 +36,10 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided pen. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The pen. /// The path. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IPen pen, Drawable path) where TColor : struct, IPackedPixel, IEquatable { @@ -54,14 +50,12 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The path. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IBrush brush, float thickness, Drawable path, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -72,13 +66,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The thickness. /// The path. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, IBrush brush, float thickness, Drawable path) where TColor : struct, IPackedPixel, IEquatable { @@ -89,14 +81,12 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The path. /// The options. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, TColor color, float thickness, Drawable path, GraphicsOptions options) where TColor : struct, IPackedPixel, IEquatable { @@ -107,13 +97,11 @@ namespace ImageSharp /// Draws the outline of the polygon with the provided brush at the provided thickness. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The thickness. /// The path. - /// - /// The Image - /// + /// The . public static Image Draw(this Image source, TColor color, float thickness, Drawable path) where TColor : struct, IPackedPixel, IEquatable { diff --git a/src/ImageSharp.Drawing/Drawable.cs b/src/ImageSharp.Drawing/Drawable.cs index b81827331..62f5e62c1 100644 --- a/src/ImageSharp.Drawing/Drawable.cs +++ b/src/ImageSharp.Drawing/Drawable.cs @@ -13,17 +13,11 @@ namespace ImageSharp.Drawing /// /// Gets the maximum number of intersections to could be returned. /// - /// - /// The maximum intersections. - /// public abstract int MaxIntersections { get; } /// /// Gets the bounds. /// - /// - /// The bounds. - /// public abstract Rectangle Bounds { get; } /// diff --git a/src/ImageSharp.Drawing/FillRegion.cs b/src/ImageSharp.Drawing/FillRegion.cs index 8d4f20b67..c634d6e64 100644 --- a/src/ImageSharp.Drawing/FillRegion.cs +++ b/src/ImageSharp.Drawing/FillRegion.cs @@ -20,9 +20,9 @@ namespace ImageSharp /// Flood fills the image with the specified brush. /// /// The type of the color. - /// The source. - /// The brush. - /// The Image + /// The image this method extends. + /// The details how to fill the region of interest. + /// The . public static Image Fill(this Image source, IBrush brush) where TColor : struct, IPackedPixel, IEquatable { @@ -33,9 +33,9 @@ namespace ImageSharp /// Flood fills the image with the specified color. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. - /// The Image + /// The . public static Image Fill(this Image source, TColor color) where TColor : struct, IPackedPixel, IEquatable { @@ -46,7 +46,7 @@ namespace ImageSharp /// Flood fills the image with in the region with the specified brush. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The region. /// The graphics options. @@ -63,7 +63,7 @@ namespace ImageSharp /// Flood fills the image with in the region with the specified brush. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The brush. /// The region. /// @@ -79,7 +79,7 @@ namespace ImageSharp /// Flood fills the image with in the region with the specified color. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The region. /// The options. @@ -96,7 +96,7 @@ namespace ImageSharp /// Flood fills the image with in the region with the specified color. /// /// The type of the color. - /// The source. + /// The image this method extends. /// The color. /// The region. /// diff --git a/src/ImageSharp.Drawing/Processors/DrawPathProcessor.cs b/src/ImageSharp.Drawing/Processors/DrawPathProcessor.cs index 53f0408d4..b4aa7fba5 100644 --- a/src/ImageSharp.Drawing/Processors/DrawPathProcessor.cs +++ b/src/ImageSharp.Drawing/Processors/DrawPathProcessor.cs @@ -28,12 +28,12 @@ namespace ImageSharp.Drawing.Processors /// /// Initializes a new instance of the class. /// - /// The pen. - /// The region. - /// The options. - public DrawPathProcessor(IPen pen, Drawable region, GraphicsOptions options) + /// The details how to draw the outline/path. + /// The details of the paths and outlines to draw. + /// The drawing configuration options. + public DrawPathProcessor(IPen pen, Drawable drawable, GraphicsOptions options) { - this.Path = region; + this.Path = drawable; this.Pen = pen; this.Options = options; } diff --git a/src/ImageSharp.Drawing/Processors/FillRegionProcessor.cs b/src/ImageSharp.Drawing/Processors/FillRegionProcessor.cs index 6719d365a..67c3ad176 100644 --- a/src/ImageSharp.Drawing/Processors/FillRegionProcessor.cs +++ b/src/ImageSharp.Drawing/Processors/FillRegionProcessor.cs @@ -26,9 +26,9 @@ namespace ImageSharp.Drawing.Processors /// /// Initializes a new instance of the class. /// - /// The brush. - /// The region. - /// The options. + /// The details how to fill the region of interest. + /// The region of interest to be filled. + /// The configuration options. public FillRegionProcessor(IBrush brush, Region region, GraphicsOptions options) { this.Region = region; diff --git a/src/ImageSharp.Drawing/Region.cs b/src/ImageSharp.Drawing/Region.cs index 95f0e1748..81f3dca5b 100644 --- a/src/ImageSharp.Drawing/Region.cs +++ b/src/ImageSharp.Drawing/Region.cs @@ -13,23 +13,20 @@ namespace ImageSharp.Drawing /// /// Gets the maximum number of intersections to could be returned. /// - /// - /// The maximum intersections. - /// public abstract int MaxIntersections { get; } /// - /// Gets the bounds. + /// Gets the bounding box that entirly surrounds this region. /// - /// - /// The bounds. - /// + /// + /// This should always contains all possible points returned from eather or . + /// public abstract Rectangle Bounds { get; } /// /// Scans the X axis for intersections. /// - /// The x. + /// The position along the X axies to find intersections. /// The buffer. /// The length. /// The offset.