Skip to content

Commit f91c5ff

Browse files
Docs cleanup and spelling
1 parent bd1ec4a commit f91c5ff

23 files changed

+105
-119
lines changed

src/ImageSharp.Drawing/Processing/Brushes.cs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ namespace SixLabors.ImageSharp.Drawing.Processing
66
/// <summary>
77
/// A collection of methods for creating generic brushes.
88
/// </summary>
9-
/// <returns>A New <see cref="PatternBrush"/></returns>
9+
/// <returns>A new <see cref="PatternBrush"/></returns>
1010
public static class Brushes
1111
{
1212
/// <summary>
@@ -92,14 +92,14 @@ public static class Brushes
9292
/// Create as brush that will paint a solid color
9393
/// </summary>
9494
/// <param name="color">The color.</param>
95-
/// <returns>A New <see cref="PatternBrush"/></returns>
95+
/// <returns>A new <see cref="PatternBrush"/></returns>
9696
public static SolidBrush Solid(Color color) => new(color);
9797

9898
/// <summary>
9999
/// Create as brush that will paint a Percent10 Hatch Pattern with the specified colors
100100
/// </summary>
101101
/// <param name="foreColor">Color of the foreground.</param>
102-
/// <returns>A New <see cref="PatternBrush"/></returns>
102+
/// <returns>A new <see cref="PatternBrush"/></returns>
103103
public static PatternBrush Percent10(Color foreColor)
104104
=> new(foreColor, Color.Transparent, Percent10Pattern);
105105

@@ -108,7 +108,7 @@ public static PatternBrush Percent10(Color foreColor)
108108
/// </summary>
109109
/// <param name="foreColor">Color of the foreground.</param>
110110
/// <param name="backColor">Color of the background.</param>
111-
/// <returns>A New <see cref="PatternBrush"/></returns>
111+
/// <returns>A new <see cref="PatternBrush"/></returns>
112112
public static PatternBrush Percent10(Color foreColor, Color backColor)
113113
=> new(foreColor, backColor, Percent10Pattern);
114114

@@ -117,7 +117,7 @@ public static PatternBrush Percent10(Color foreColor, Color backColor)
117117
/// transparent background.
118118
/// </summary>
119119
/// <param name="foreColor">Color of the foreground.</param>
120-
/// <returns>A New <see cref="PatternBrush"/></returns>
120+
/// <returns>A new <see cref="PatternBrush"/></returns>
121121
public static PatternBrush Percent20(Color foreColor)
122122
=> new(foreColor, Color.Transparent, Percent20Pattern);
123123

@@ -126,7 +126,7 @@ public static PatternBrush Percent20(Color foreColor)
126126
/// </summary>
127127
/// <param name="foreColor">Color of the foreground.</param>
128128
/// <param name="backColor">Color of the background.</param>
129-
/// <returns>A New <see cref="PatternBrush"/></returns>
129+
/// <returns>A new <see cref="PatternBrush"/></returns>
130130
public static PatternBrush Percent20(Color foreColor, Color backColor)
131131
=> new(foreColor, backColor, Percent20Pattern);
132132

@@ -135,7 +135,7 @@ public static PatternBrush Percent20(Color foreColor, Color backColor)
135135
/// transparent background.
136136
/// </summary>
137137
/// <param name="foreColor">Color of the foreground.</param>
138-
/// <returns>A New <see cref="PatternBrush"/></returns>
138+
/// <returns>A new <see cref="PatternBrush"/></returns>
139139
public static PatternBrush Horizontal(Color foreColor)
140140
=> new(foreColor, Color.Transparent, HorizontalPattern);
141141

@@ -144,7 +144,7 @@ public static PatternBrush Horizontal(Color foreColor)
144144
/// </summary>
145145
/// <param name="foreColor">Color of the foreground.</param>
146146
/// <param name="backColor">Color of the background.</param>
147-
/// <returns>A New <see cref="PatternBrush"/></returns>
147+
/// <returns>A new <see cref="PatternBrush"/></returns>
148148
public static PatternBrush Horizontal(Color foreColor, Color backColor)
149149
=> new(foreColor, backColor, HorizontalPattern);
150150

@@ -153,7 +153,7 @@ public static PatternBrush Horizontal(Color foreColor, Color backColor)
153153
/// transparent background.
154154
/// </summary>
155155
/// <param name="foreColor">Color of the foreground.</param>
156-
/// <returns>A New <see cref="PatternBrush"/></returns>
156+
/// <returns>A new <see cref="PatternBrush"/></returns>
157157
public static PatternBrush Min(Color foreColor)
158158
=> new(foreColor, Color.Transparent, MinPattern);
159159

@@ -162,7 +162,7 @@ public static PatternBrush Min(Color foreColor)
162162
/// </summary>
163163
/// <param name="foreColor">Color of the foreground.</param>
164164
/// <param name="backColor">Color of the background.</param>
165-
/// <returns>A New <see cref="PatternBrush"/></returns>
165+
/// <returns>A new <see cref="PatternBrush"/></returns>
166166
public static PatternBrush Min(Color foreColor, Color backColor)
167167
=> new(foreColor, backColor, MinPattern);
168168

@@ -171,7 +171,7 @@ public static PatternBrush Min(Color foreColor, Color backColor)
171171
/// transparent background.
172172
/// </summary>
173173
/// <param name="foreColor">Color of the foreground.</param>
174-
/// <returns>A New <see cref="PatternBrush"/></returns>
174+
/// <returns>A new <see cref="PatternBrush"/></returns>
175175
public static PatternBrush Vertical(Color foreColor)
176176
=> new(foreColor, Color.Transparent, VerticalPattern);
177177

@@ -180,7 +180,7 @@ public static PatternBrush Vertical(Color foreColor)
180180
/// </summary>
181181
/// <param name="foreColor">Color of the foreground.</param>
182182
/// <param name="backColor">Color of the background.</param>
183-
/// <returns>A New <see cref="PatternBrush"/></returns>
183+
/// <returns>A new <see cref="PatternBrush"/></returns>
184184
public static PatternBrush Vertical(Color foreColor, Color backColor)
185185
=> new(foreColor, backColor, VerticalPattern);
186186

@@ -189,7 +189,7 @@ public static PatternBrush Vertical(Color foreColor, Color backColor)
189189
/// transparent background.
190190
/// </summary>
191191
/// <param name="foreColor">Color of the foreground.</param>
192-
/// <returns>A New <see cref="PatternBrush"/></returns>
192+
/// <returns>A new <see cref="PatternBrush"/></returns>
193193
public static PatternBrush ForwardDiagonal(Color foreColor)
194194
=> new(foreColor, Color.Transparent, ForwardDiagonalPattern);
195195

@@ -198,7 +198,7 @@ public static PatternBrush ForwardDiagonal(Color foreColor)
198198
/// </summary>
199199
/// <param name="foreColor">Color of the foreground.</param>
200200
/// <param name="backColor">Color of the background.</param>
201-
/// <returns>A New <see cref="PatternBrush"/></returns>
201+
/// <returns>A new <see cref="PatternBrush"/></returns>
202202
public static PatternBrush ForwardDiagonal(Color foreColor, Color backColor)
203203
=> new(foreColor, backColor, ForwardDiagonalPattern);
204204

@@ -207,7 +207,7 @@ public static PatternBrush ForwardDiagonal(Color foreColor, Color backColor)
207207
/// transparent background.
208208
/// </summary>
209209
/// <param name="foreColor">Color of the foreground.</param>
210-
/// <returns>A New <see cref="PatternBrush"/></returns>
210+
/// <returns>A new <see cref="PatternBrush"/></returns>
211211
public static PatternBrush BackwardDiagonal(Color foreColor)
212212
=> new(foreColor, Color.Transparent, BackwardDiagonalPattern);
213213

@@ -216,7 +216,7 @@ public static PatternBrush BackwardDiagonal(Color foreColor)
216216
/// </summary>
217217
/// <param name="foreColor">Color of the foreground.</param>
218218
/// <param name="backColor">Color of the background.</param>
219-
/// <returns>A New <see cref="PatternBrush"/></returns>
219+
/// <returns>A new <see cref="PatternBrush"/></returns>
220220
public static PatternBrush BackwardDiagonal(Color foreColor, Color backColor)
221221
=> new(foreColor, backColor, BackwardDiagonalPattern);
222222
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace SixLabors.ImageSharp.Drawing.Processing
77
{
88
/// <summary>
9-
/// Adds extensions that allow the drawing of Bezier paths to the <see cref="Image{TPixel}"/> type.
9+
/// Adds extensions that allow the drawing of Bezier paths.
1010
/// </summary>
1111
public static class DrawBezierExtensions
1212
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace SixLabors.ImageSharp.Drawing.Processing
77
{
88
/// <summary>
9-
/// Adds extensions that allow the drawing of collections of polygon outlines to the <see cref="Image{TPixel}"/> type.
9+
/// Adds extensions that allow the drawing of collections of polygon outlines.
1010
/// </summary>
1111
public static class DrawPathCollectionExtensions
1212
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace SixLabors.ImageSharp.Drawing.Processing
88
{
99
/// <summary>
10-
/// Adds extensions that allow the drawing of polygon outlines to the <see cref="Image{TPixel}"/> type.
10+
/// Adds extensions that allow the drawing of polygon outlines.
1111
/// </summary>
1212
public static class DrawPathExtensions
1313
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace SixLabors.ImageSharp.Drawing.Processing
99
{
1010
/// <summary>
11-
/// Adds extensions that allow the drawing of text on an image.
11+
/// Adds extensions that allow the drawing of text.
1212
/// </summary>
1313
public static class DrawTextExtensions
1414
{

src/ImageSharp.Drawing/Processing/GradientRepetitionMode.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ namespace SixLabors.ImageSharp.Drawing.Processing
99
public enum GradientRepetitionMode
1010
{
1111
/// <summary>
12-
/// don't repeat, keep the color of start and end beyond those points stable.
12+
/// Don't repeat, keep the color of start and end beyond those points stable.
1313
/// </summary>
1414
None,
1515

@@ -28,8 +28,7 @@ public enum GradientRepetitionMode
2828

2929
/// <summary>
3030
/// With DontFill a gradient does not touch any pixel beyond it's borders.
31-
/// For the <see cref="LinearGradientBrush" /> this is beyond the orthogonal through start and end,
32-
/// TODO For the cref="PolygonalGradientBrush" it's outside the polygon,
31+
/// For the <see cref="LinearGradientBrush"/> this is beyond the orthogonal through start and end,
3332
/// For <see cref="RadialGradientBrush" /> and <see cref="EllipticGradientBrush" /> it's beyond 1.0.
3433
/// </summary>
3534
DontFill

src/ImageSharp.Drawing/Processing/ImageBrush.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public ImageBrush(Image image)
3838
/// <param name="image">The image.</param>
3939
/// <param name="region">
4040
/// The region of interest.
41-
/// This overrides any region used to intitialize the brush applicator.
41+
/// This overrides any region used to initialize the brush applicator.
4242
/// </param>
4343
internal ImageBrush(Image image, RectangleF region)
4444
{

src/ImageSharp.Drawing/Processing/PatternPen.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace SixLabors.ImageSharp.Drawing.Processing
1515
/// <list type="bullet">
1616
/// <item>Section 1 will be width long (making a square) and will be filled by the brush.</item>
1717
/// <item>Section 2 will be width * 2 long and will be empty.</item>
18-
/// <item>ection 3 will be width/2 long and will be filled.</item>
18+
/// <item>Section 3 will be width/2 long and will be filled.</item>
1919
/// </list>
2020
/// The pattern will immediately repeat without gap.
2121
/// </remarks>

src/ImageSharp.Drawing/Processing/Pen.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ namespace SixLabors.ImageSharp.Drawing.Processing
1717
/// <list type="bullet">
1818
/// <item>Section 1 will be width long (making a square) and will be filled by the brush.</item>
1919
/// <item>Section 2 will be width * 2 long and will be empty.</item>
20-
/// <item>ection 3 will be width/2 long and will be filled.</item>
20+
/// <item>Section 3 will be width/2 long and will be filled.</item>
2121
/// </list>
2222
/// The pattern will immediately repeat without gap.
2323
/// </remarks>

src/ImageSharp.Drawing/Processing/Pens.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace SixLabors.ImageSharp.Drawing.Processing
77
{
88
/// <summary>
9-
/// Contains a collection of common Pen styles
9+
/// Contains a collection of common pen styles.
1010
/// </summary>
1111
public static class Pens
1212
{
@@ -20,94 +20,94 @@ public static class Pens
2020
/// Create a solid pen without any drawing patterns
2121
/// </summary>
2222
/// <param name="color">The color.</param>
23-
/// <returns>The Pen</returns>
23+
/// <returns>The <see cref="Pen"/>.</returns>
2424
public static SolidPen Solid(Color color) => new(color);
2525

2626
/// <summary>
2727
/// Create a solid pen without any drawing patterns
2828
/// </summary>
2929
/// <param name="brush">The brush.</param>
30-
/// <returns>The Pen</returns>
30+
/// <returns>The <see cref="Pen"/>.</returns>
3131
public static SolidPen Solid(Brush brush) => new(brush);
3232

3333
/// <summary>
3434
/// Create a solid pen without any drawing patterns
3535
/// </summary>
3636
/// <param name="color">The color.</param>
3737
/// <param name="width">The width.</param>
38-
/// <returns>The Pen</returns>
38+
/// <returns>The <see cref="Pen"/>.</returns>
3939
public static SolidPen Solid(Color color, float width) => new(color, width);
4040

4141
/// <summary>
4242
/// Create a solid pen without any drawing patterns
4343
/// </summary>
4444
/// <param name="brush">The brush.</param>
4545
/// <param name="width">The width.</param>
46-
/// <returns>The Pen</returns>
46+
/// <returns>The <see cref="Pen"/>.</returns>
4747
public static SolidPen Solid(Brush brush, float width) => new(brush, width);
4848

4949
/// <summary>
5050
/// Create a pen with a 'Dash' drawing patterns
5151
/// </summary>
5252
/// <param name="color">The color.</param>
5353
/// <param name="width">The width.</param>
54-
/// <returns>The Pen</returns>
54+
/// <returns>The <see cref="Pen"/>.</returns>
5555
public static PatternPen Dash(Color color, float width) => new(color, width, DashedPattern);
5656

5757
/// <summary>
5858
/// Create a pen with a 'Dash' drawing patterns
5959
/// </summary>
6060
/// <param name="brush">The brush.</param>
6161
/// <param name="width">The width.</param>
62-
/// <returns>The Pen</returns>
62+
/// <returns>The <see cref="Pen"/>.</returns>
6363
public static PatternPen Dash(Brush brush, float width) => new(brush, width, DashedPattern);
6464

6565
/// <summary>
6666
/// Create a pen with a 'Dot' drawing patterns
6767
/// </summary>
6868
/// <param name="color">The color.</param>
6969
/// <param name="width">The width.</param>
70-
/// <returns>The Pen</returns>
70+
/// <returns>The <see cref="Pen"/>.</returns>
7171
public static PatternPen Dot(Color color, float width) => new(color, width, DottedPattern);
7272

7373
/// <summary>
7474
/// Create a pen with a 'Dot' drawing patterns
7575
/// </summary>
7676
/// <param name="brush">The brush.</param>
7777
/// <param name="width">The width.</param>
78-
/// <returns>The Pen</returns>
78+
/// <returns>The <see cref="Pen"/>.</returns>
7979
public static PatternPen Dot(Brush brush, float width) => new(brush, width, DottedPattern);
8080

8181
/// <summary>
8282
/// Create a pen with a 'Dash Dot' drawing patterns
8383
/// </summary>
8484
/// <param name="color">The color.</param>
8585
/// <param name="width">The width.</param>
86-
/// <returns>The Pen</returns>
86+
/// <returns>The <see cref="Pen"/>.</returns>
8787
public static PatternPen DashDot(Color color, float width) => new(color, width, DashDotPattern);
8888

8989
/// <summary>
9090
/// Create a pen with a 'Dash Dot' drawing patterns
9191
/// </summary>
9292
/// <param name="brush">The brush.</param>
9393
/// <param name="width">The width.</param>
94-
/// <returns>The Pen</returns>
94+
/// <returns>The <see cref="Pen"/>.</returns>
9595
public static PatternPen DashDot(Brush brush, float width) => new(brush, width, DashDotPattern);
9696

9797
/// <summary>
9898
/// Create a pen with a 'Dash Dot Dot' drawing patterns
9999
/// </summary>
100100
/// <param name="color">The color.</param>
101101
/// <param name="width">The width.</param>
102-
/// <returns>The Pen</returns>
102+
/// <returns>The <see cref="Pen"/>.</returns>
103103
public static PatternPen DashDotDot(Color color, float width) => new(color, width, DashDotDotPattern);
104104

105105
/// <summary>
106106
/// Create a pen with a 'Dash Dot Dot' drawing patterns
107107
/// </summary>
108108
/// <param name="brush">The brush.</param>
109109
/// <param name="width">The width.</param>
110-
/// <returns>The Pen</returns>
110+
/// <returns>The <see cref="Pen"/>.</returns>
111111
public static PatternPen DashDotDot(Brush brush, float width) => new(brush, width, DashDotDotPattern);
112112
}
113113
}

0 commit comments

Comments
 (0)