Skip to content

Commit e6dfe70

Browse files
JimBobSquarePantsJimBobSquarePants
committed
Fix docs
1 parent 5bbba72 commit e6dfe70

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

‎src/ImageSharp.Drawing/Shapes/ClipPathExtensions.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class ClipPathExtensions
1717
/// <param name="shape">The shape.</param>
1818
/// <param name="holes">The holes.</param>
1919
/// <returns>Returns a new shape with the holes clipped out of the shape.</returns>
20-
/// <exception cref="ClipperException">GenerateClippedShapes: Open paths have been disabled.</exception>
20+
/// <exception cref="ClipperException">Open paths have been disabled.</exception>
2121
public static IPath Clip(this IPath shape, IEnumerable<IPath> holes)
2222
{
2323
var clipper = new Clipper();
@@ -36,7 +36,7 @@ public static IPath Clip(this IPath shape, IEnumerable<IPath> holes)
3636
/// <param name="shape">The shape.</param>
3737
/// <param name="holes">The holes.</param>
3838
/// <returns>Returns a new shape with the holes clipped out of the shape.</returns>
39-
/// <exception cref="ClipperException">GenerateClippedShapes: Open paths have been disabled.</exception>
39+
/// <exception cref="ClipperException">Open paths have been disabled.</exception>
4040
public static IPath Clip(this IPath shape, params IPath[] holes)
4141
=> shape.Clip((IEnumerable<IPath>)holes);
4242
}

‎src/ImageSharp.Drawing/Shapes/OutlinePathExtensions.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public static class OutlinePathExtensions
2222
/// <param name="width">The final width outline</param>
2323
/// <param name="pattern">The pattern made of multiples of the width.</param>
2424
/// <returns>A new path representing the outline.</returns>
25-
/// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
25+
/// <exception cref="ClipperException">Couldn't calculate offset.</exception>
2626
public static IPath GenerateOutline(this IPath path, float width, float[] pattern)
2727
=> path.GenerateOutline(width, new ReadOnlySpan<float>(pattern));
2828

@@ -33,7 +33,7 @@ public static IPath GenerateOutline(this IPath path, float width, float[] patter
3333
/// <param name="width">The final width outline</param>
3434
/// <param name="pattern">The pattern made of multiples of the width.</param>
3535
/// <returns>A new path representing the outline.</returns>
36-
/// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
36+
/// <exception cref="ClipperException">Couldn't calculate offset.</exception>
3737
public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern)
3838
=> path.GenerateOutline(width, pattern, false);
3939

@@ -45,7 +45,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
4545
/// <param name="pattern">The pattern made of multiples of the width.</param>
4646
/// <param name="startOff">Weather the first item in the pattern is on or off.</param>
4747
/// <returns>A new path representing the outline.</returns>
48-
/// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
48+
/// <exception cref="ClipperException">Couldn't calculate offset.</exception>
4949
public static IPath GenerateOutline(this IPath path, float width, float[] pattern, bool startOff)
5050
=> path.GenerateOutline(width, new ReadOnlySpan<float>(pattern), startOff);
5151

@@ -57,7 +57,7 @@ public static IPath GenerateOutline(this IPath path, float width, float[] patter
5757
/// <param name="pattern">The pattern made of multiples of the width.</param>
5858
/// <param name="startOff">Weather the first item in the pattern is on or off.</param>
5959
/// <returns>A new path representing the outline.</returns>
60-
/// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
60+
/// <exception cref="ClipperException">Couldn't calculate offset.</exception>
6161
public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, bool startOff)
6262
=> GenerateOutline(path, width, pattern, startOff, JointStyle.Square, EndCapStyle.Butt);
6363

@@ -71,7 +71,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
7171
/// <param name="jointStyle">The style to render the joints.</param>
7272
/// <param name="patternSectionCapStyle">The style to render between sections of the specified pattern.</param>
7373
/// <returns>A new path representing the outline.</returns>
74-
/// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
74+
/// <exception cref="ClipperException">Couldn't calculate offset.</exception>
7575
public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, bool startOff, JointStyle jointStyle = JointStyle.Square, EndCapStyle patternSectionCapStyle = EndCapStyle.Butt)
7676
{
7777
if (pattern.Length < 2)
@@ -172,7 +172,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
172172
/// <param name="path">the path to outline</param>
173173
/// <param name="width">The final width outline</param>
174174
/// <returns>A new path representing the outline.</returns>
175-
/// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
175+
/// <exception cref="ClipperException">Couldn't calculate offset.</exception>
176176
public static IPath GenerateOutline(this IPath path, float width) => GenerateOutline(path, width, JointStyle.Square, EndCapStyle.Butt);
177177

178178
/// <summary>
@@ -183,7 +183,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
183183
/// <param name="jointStyle">The style to render the joints.</param>
184184
/// <param name="endCapStyle">The style to render the end caps of open paths (ignored on closed paths).</param>
185185
/// <returns>A new path representing the outline.</returns>
186-
/// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
186+
/// <exception cref="ClipperException">Couldn't calculate offset.</exception>
187187
public static IPath GenerateOutline(this IPath path, float width, JointStyle jointStyle = JointStyle.Square, EndCapStyle endCapStyle = EndCapStyle.Square)
188188
{
189189
var offset = new ClipperOffset(MiterOffsetDelta);

‎src/ImageSharp.Drawing/Shapes/PolygonClipper/Clipper.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ public IPath[] GenerateClippedShapes()
8080
/// Adds the paths.
8181
/// </summary>
8282
/// <param name="paths">The paths.</param>
83-
/// <exception cref="ClipperException">AddPath: Open paths have been disabled</exception>
83+
/// <exception cref="ClipperException">Open paths have been disabled.</exception>
8484
public void AddPaths(ClippablePath[] paths)
8585
{
8686
Guard.NotNull(paths, nameof(paths));
@@ -98,7 +98,7 @@ public void AddPaths(ClippablePath[] paths)
9898
/// </summary>
9999
/// <param name="paths">The paths.</param>
100100
/// <param name="clippingType">The clipping type.</param>
101-
/// <exception cref="ClipperException">AddPath: Open paths have been disabled </exception>
101+
/// <exception cref="ClipperException">Open paths have been disabled.</exception>
102102
public void AddPaths(IEnumerable<IPath> paths, ClippingType clippingType)
103103
{
104104
Guard.NotNull(paths, nameof(paths));
@@ -114,7 +114,7 @@ public void AddPaths(IEnumerable<IPath> paths, ClippingType clippingType)
114114
/// </summary>
115115
/// <param name="path">The path.</param>
116116
/// <param name="clippingType">The clipping type.</param>
117-
/// <exception cref="ClipperException">AddPath: Open paths have been disabled </exception>
117+
/// <exception cref="ClipperException">Open paths have been disabled.</exception>
118118
public void AddPath(IPath path, ClippingType clippingType)
119119
{
120120
Guard.NotNull(path, nameof(path));
@@ -130,7 +130,7 @@ public void AddPath(IPath path, ClippingType clippingType)
130130
/// </summary>
131131
/// <param name="path">The path.</param>
132132
/// <param name="clippingType">Type of the poly.</param>
133-
/// <exception cref="ClipperException">AddPath: Open paths have been disabled.</exception>
133+
/// <exception cref="ClipperException">Open paths have been disabled.</exception>
134134
internal void AddPath(ISimplePath path, ClippingType clippingType)
135135
{
136136
ReadOnlySpan<PointF> vectors = path.Points.Span;

0 commit comments

Comments
 (0)