Skip to content

Commit cf387ef

Browse files
committed
update return type comment for all exterions
1 parent eda9825 commit cf387ef

17 files changed

Lines changed: 80 additions & 80 deletions

src/ImageSharp.Drawing/Processing/Extensions/ClearExtensions.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ internal static GraphicsOptions CloneForClearOperation(this GraphicsOptions opti
3131
/// <param name="source">The image this method extends.</param>
3232
/// <param name="options">The graphics options.</param>
3333
/// <param name="brush">The details how to fill the region of interest.</param>
34-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
34+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
3535
public static IImageProcessingContext Clear(
3636
this IImageProcessingContext source,
3737
GraphicsOptions options,
@@ -43,7 +43,7 @@ public static IImageProcessingContext Clear(
4343
/// </summary>
4444
/// <param name="source">The image this method extends.</param>
4545
/// <param name="brush">The details how to fill the region of interest.</param>
46-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
46+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
4747
public static IImageProcessingContext Clear(this IImageProcessingContext source, IBrush brush) =>
4848
source.Clear(source.GetGraphicsOptions(), brush);
4949

@@ -53,7 +53,7 @@ public static IImageProcessingContext Clear(this IImageProcessingContext source,
5353
/// <param name="source">The image this method extends.</param>
5454
/// <param name="options">The graphics options.</param>
5555
/// <param name="color">The color.</param>
56-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
56+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
5757
public static IImageProcessingContext Clear(
5858
this IImageProcessingContext source,
5959
GraphicsOptions options,
@@ -65,7 +65,7 @@ public static IImageProcessingContext Clear(
6565
/// </summary>
6666
/// <param name="source">The image this method extends.</param>
6767
/// <param name="color">The color.</param>
68-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
68+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
6969
public static IImageProcessingContext Clear(this IImageProcessingContext source, Color color) =>
7070
source.Clear(new SolidBrush(color));
7171
}

src/ImageSharp.Drawing/Processing/Extensions/ClearPathExtensions.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ internal static ShapeGraphicsOptions CloneForClearOperation(this ShapeGraphicsOp
3232
/// <param name="options">The graphics options.</param>
3333
/// <param name="brush">The brush.</param>
3434
/// <param name="path">The shape.</param>
35-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
35+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
3636
public static IImageProcessingContext Clear(
3737
this IImageProcessingContext source,
3838
ShapeGraphicsOptions options,
@@ -46,7 +46,7 @@ public static IImageProcessingContext Clear(
4646
/// <param name="source">The image this method extends.</param>
4747
/// <param name="brush">The brush.</param>
4848
/// <param name="path">The path.</param>
49-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
49+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
5050
public static IImageProcessingContext Clear(this IImageProcessingContext source, IBrush brush, IPath path) =>
5151
source.Clear(source.GetShapeGraphicsOptions(), brush, path);
5252

@@ -57,7 +57,7 @@ public static IImageProcessingContext Clear(this IImageProcessingContext source,
5757
/// <param name="options">The options.</param>
5858
/// <param name="color">The color.</param>
5959
/// <param name="path">The path.</param>
60-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
60+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
6161
public static IImageProcessingContext Clear(
6262
this IImageProcessingContext source,
6363
ShapeGraphicsOptions options,
@@ -71,7 +71,7 @@ public static IImageProcessingContext Clear(
7171
/// <param name="source">The image this method extends.</param>
7272
/// <param name="color">The color.</param>
7373
/// <param name="path">The path.</param>
74-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
74+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
7575
public static IImageProcessingContext Clear(this IImageProcessingContext source, Color color, IPath path) =>
7676
source.Clear(new SolidBrush(color), path);
7777
}

src/ImageSharp.Drawing/Processing/Extensions/ClearRectangleExtensions.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class ClearRectangleExtensions
1717
/// <param name="options">The options.</param>
1818
/// <param name="brush">The brush.</param>
1919
/// <param name="shape">The shape.</param>
20-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
20+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
2121
public static IImageProcessingContext Clear(
2222
this IImageProcessingContext source,
2323
ShapeGraphicsOptions options,
@@ -31,7 +31,7 @@ public static IImageProcessingContext Clear(
3131
/// <param name="source">The image this method extends.</param>
3232
/// <param name="brush">The brush.</param>
3333
/// <param name="shape">The shape.</param>
34-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
34+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
3535
public static IImageProcessingContext Clear(this IImageProcessingContext source, IBrush brush, RectangleF shape) =>
3636
source.Clear(brush, new RectangularPolygon(shape.X, shape.Y, shape.Width, shape.Height));
3737

@@ -42,7 +42,7 @@ public static IImageProcessingContext Clear(this IImageProcessingContext source,
4242
/// <param name="options">The options.</param>
4343
/// <param name="color">The color.</param>
4444
/// <param name="shape">The shape.</param>
45-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
45+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
4646
public static IImageProcessingContext Clear(
4747
this IImageProcessingContext source,
4848
ShapeGraphicsOptions options,
@@ -56,7 +56,7 @@ public static IImageProcessingContext Clear(
5656
/// <param name="source">The image this method extends.</param>
5757
/// <param name="color">The color.</param>
5858
/// <param name="shape">The shape.</param>
59-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
59+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
6060
public static IImageProcessingContext Clear(this IImageProcessingContext source, Color color, RectangleF shape) =>
6161
source.Clear(new SolidBrush(color), shape);
6262
}

src/ImageSharp.Drawing/Processing/Extensions/ClearRegionExtensions.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class ClearRegionExtensions
1717
/// <param name="source">The image this method extends.</param>
1818
/// <param name="brush">The brush.</param>
1919
/// <param name="region">The region.</param>
20-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
20+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
2121
public static IImageProcessingContext Clear(this IImageProcessingContext source, IBrush brush, Region region) =>
2222
source.Clear(source.GetShapeGraphicsOptions(), brush, region);
2323

@@ -28,7 +28,7 @@ public static IImageProcessingContext Clear(this IImageProcessingContext source,
2828
/// <param name="options">The graphics options.</param>
2929
/// <param name="brush">The brush.</param>
3030
/// <param name="region">The region.</param>
31-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
31+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
3232
public static IImageProcessingContext Clear(
3333
this IImageProcessingContext source,
3434
ShapeGraphicsOptions options,
@@ -43,7 +43,7 @@ public static IImageProcessingContext Clear(
4343
/// <param name="options">The options.</param>
4444
/// <param name="color">The color.</param>
4545
/// <param name="region">The region.</param>
46-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
46+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
4747
public static IImageProcessingContext Clear(
4848
this IImageProcessingContext source,
4949
ShapeGraphicsOptions options,
@@ -57,7 +57,7 @@ public static IImageProcessingContext Clear(
5757
/// <param name="source">The image this method extends.</param>
5858
/// <param name="color">The color.</param>
5959
/// <param name="region">The region.</param>
60-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
60+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
6161
public static IImageProcessingContext Clear(this IImageProcessingContext source, Color color, Region region) =>
6262
source.Clear(new SolidBrush(color), region);
6363
}

src/ImageSharp.Drawing/Processing/Extensions/DrawBezierExtensions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class DrawBezierExtensions
1717
/// <param name="options">The options.</param>
1818
/// <param name="pen">The pen.</param>
1919
/// <param name="points">The points.</param>
20-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
20+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
2121
public static IImageProcessingContext DrawBeziers(
2222
this IImageProcessingContext source,
2323
ShapeGraphicsOptions options,
@@ -31,7 +31,7 @@ public static IImageProcessingContext DrawBeziers(
3131
/// <param name="source">The image this method extends.</param>
3232
/// <param name="pen">The pen.</param>
3333
/// <param name="points">The points.</param>
34-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
34+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
3535
public static IImageProcessingContext DrawBeziers(
3636
this IImageProcessingContext source,
3737
IPen pen,
@@ -46,7 +46,7 @@ public static IImageProcessingContext DrawBeziers(
4646
/// <param name="brush">The brush.</param>
4747
/// <param name="thickness">The thickness.</param>
4848
/// <param name="points">The points.</param>
49-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
49+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
5050
public static IImageProcessingContext DrawBeziers(
5151
this IImageProcessingContext source,
5252
ShapeGraphicsOptions options,
@@ -62,7 +62,7 @@ public static IImageProcessingContext DrawBeziers(
6262
/// <param name="brush">The brush.</param>
6363
/// <param name="thickness">The thickness.</param>
6464
/// <param name="points">The points.</param>
65-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
65+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
6666
public static IImageProcessingContext DrawBeziers(
6767
this IImageProcessingContext source,
6868
IBrush brush,
@@ -77,7 +77,7 @@ public static IImageProcessingContext DrawBeziers(
7777
/// <param name="color">The color.</param>
7878
/// <param name="thickness">The thickness.</param>
7979
/// <param name="points">The points.</param>
80-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
80+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
8181
public static IImageProcessingContext DrawBeziers(
8282
this IImageProcessingContext source,
8383
Color color,
@@ -93,7 +93,7 @@ public static IImageProcessingContext DrawBeziers(
9393
/// <param name="color">The color.</param>
9494
/// <param name="thickness">The thickness.</param>
9595
/// <param name="points">The points.</param>
96-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
96+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
9797
public static IImageProcessingContext DrawBeziers(
9898
this IImageProcessingContext source,
9999
ShapeGraphicsOptions options,

src/ImageSharp.Drawing/Processing/Extensions/DrawLineExtensions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public static class DrawLineExtensions
1818
/// <param name="brush">The brush.</param>
1919
/// <param name="thickness">The thickness.</param>
2020
/// <param name="points">The points.</param>
21-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
21+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
2222
public static IImageProcessingContext DrawLines(
2323
this IImageProcessingContext source,
2424
ShapeGraphicsOptions options,
@@ -34,7 +34,7 @@ public static IImageProcessingContext DrawLines(
3434
/// <param name="brush">The brush.</param>
3535
/// <param name="thickness">The thickness.</param>
3636
/// <param name="points">The points.</param>
37-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
37+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
3838
public static IImageProcessingContext DrawLines(
3939
this IImageProcessingContext source,
4040
IBrush brush,
@@ -49,7 +49,7 @@ public static IImageProcessingContext DrawLines(
4949
/// <param name="color">The color.</param>
5050
/// <param name="thickness">The thickness.</param>
5151
/// <param name="points">The points.</param>
52-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
52+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
5353
public static IImageProcessingContext DrawLines(
5454
this IImageProcessingContext source,
5555
Color color,
@@ -65,7 +65,7 @@ public static IImageProcessingContext DrawLines(
6565
/// <param name="color">The color.</param>
6666
/// <param name="thickness">The thickness.</param>
6767
/// <param name="points">The points.</param>
68-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>>
68+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>>
6969
public static IImageProcessingContext DrawLines(
7070
this IImageProcessingContext source,
7171
ShapeGraphicsOptions options,
@@ -81,7 +81,7 @@ public static IImageProcessingContext DrawLines(
8181
/// <param name="options">The options.</param>
8282
/// <param name="pen">The pen.</param>
8383
/// <param name="points">The points.</param>
84-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
84+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
8585
public static IImageProcessingContext DrawLines(
8686
this IImageProcessingContext source,
8787
ShapeGraphicsOptions options,
@@ -95,7 +95,7 @@ public static IImageProcessingContext DrawLines(
9595
/// <param name="source">The image this method extends.</param>
9696
/// <param name="pen">The pen.</param>
9797
/// <param name="points">The points.</param>
98-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
98+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
9999
public static IImageProcessingContext DrawLines(
100100
this IImageProcessingContext source,
101101
IPen pen,

src/ImageSharp.Drawing/Processing/Extensions/DrawPathCollectionExtensions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class DrawPathCollectionExtensions
1717
/// <param name="options">The options.</param>
1818
/// <param name="pen">The pen.</param>
1919
/// <param name="paths">The paths.</param>
20-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
20+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
2121
public static IImageProcessingContext Draw(
2222
this IImageProcessingContext source,
2323
ShapeGraphicsOptions options,
@@ -38,7 +38,7 @@ public static IImageProcessingContext Draw(
3838
/// <param name="source">The image this method extends.</param>
3939
/// <param name="pen">The pen.</param>
4040
/// <param name="paths">The paths.</param>
41-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
41+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
4242
public static IImageProcessingContext
4343
Draw(this IImageProcessingContext source, IPen pen, IPathCollection paths) =>
4444
source.Draw(source.GetShapeGraphicsOptions(), pen, paths);
@@ -51,7 +51,7 @@ public static IImageProcessingContext
5151
/// <param name="brush">The brush.</param>
5252
/// <param name="thickness">The thickness.</param>
5353
/// <param name="paths">The shapes.</param>
54-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
54+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
5555
public static IImageProcessingContext Draw(
5656
this IImageProcessingContext source,
5757
ShapeGraphicsOptions options,
@@ -67,7 +67,7 @@ public static IImageProcessingContext Draw(
6767
/// <param name="brush">The brush.</param>
6868
/// <param name="thickness">The thickness.</param>
6969
/// <param name="paths">The paths.</param>
70-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
70+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
7171
public static IImageProcessingContext Draw(
7272
this IImageProcessingContext source,
7373
IBrush brush,
@@ -83,7 +83,7 @@ public static IImageProcessingContext Draw(
8383
/// <param name="color">The color.</param>
8484
/// <param name="thickness">The thickness.</param>
8585
/// <param name="paths">The paths.</param>
86-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
86+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
8787
public static IImageProcessingContext Draw(
8888
this IImageProcessingContext source,
8989
ShapeGraphicsOptions options,
@@ -99,7 +99,7 @@ public static IImageProcessingContext Draw(
9999
/// <param name="color">The color.</param>
100100
/// <param name="thickness">The thickness.</param>
101101
/// <param name="paths">The paths.</param>
102-
/// <returns>The <see cref="Image{TPixel}"/>.</returns>
102+
/// <returns>The <see cref="IImageProcessingContext"/> to allow chaining of operations.</returns>
103103
public static IImageProcessingContext Draw(
104104
this IImageProcessingContext source,
105105
Color color,

0 commit comments

Comments
 (0)