Change ClipperLib.ClipperExcpetion to public, remove the try..catch and adjust documentation

Author: obayomy

src/ImageSharp.Drawing/ImageSharp.Drawing.csproj

@@ -15,6 +15,10 @@
     <TargetFrameworks>netcoreapp3.1;netcoreapp2.1;netstandard2.1;netstandard2.0;netstandard1.3;net472</TargetFrameworks>
   </PropertyGroup>
 
+  <ItemGroup>
+    <Compile Remove="Shapes\PolygonClipper\ClipperException.cs" />
+  </ItemGroup>
+
   <ItemGroup>
     <None Include="..\..\shared-infrastructure\branding\icons\imagesharp.drawing\sixlabors.imagesharp.drawing.128.png" Pack="true" PackagePath="" />
   </ItemGroup>

src/ImageSharp.Drawing/Shapes/Clipper/clipper.cs

@@ -1,4 +1,4 @@
-// <auto-generated />
+// <auto-generated />
 // not really auto generated but is a code based dependency from https://sourceforge.net/projects/polyclipping/
 // only update is to make everything internal
 /*******************************************************************************
@@ -4987,9 +4987,20 @@ internal void DoRound(int j, int k)
         //------------------------------------------------------------------------------
     }
 
-    class ClipperException : Exception
+    /// <summary>
+    /// Clipper Exception
+    /// </summary>
+    /// <seealso cref="System.Exception" />
+    public class ClipperException : Exception
     {
-        public ClipperException(string description) : base(description) { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ClipperException"/> class.
+        /// </summary>
+        /// <param name="description">The description.</param>
+        public ClipperException(string description)
+            : base(description)
+        {
+        }
     }
     //------------------------------------------------------------------------------
 

src/ImageSharp.Drawing/Shapes/OutlinePathExtensions.cs

@@ -22,7 +22,7 @@ public static class OutlinePathExtensions
         /// <param name="width">The final width outline</param>
         /// <param name="pattern">The pattern made of multiples of the width.</param>
         /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Execute: Couldn't caculate Offset</exception>
+        /// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
         public static IPath GenerateOutline(this IPath path, float width, float[] pattern)
             => path.GenerateOutline(width, new ReadOnlySpan<float>(pattern));
 
@@ -33,7 +33,7 @@ public static IPath GenerateOutline(this IPath path, float width, float[] patter
         /// <param name="width">The final width outline</param>
         /// <param name="pattern">The pattern made of multiples of the width.</param>
         /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Execute: Couldn't caculate Offset</exception>
+        /// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
         public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern)
             => path.GenerateOutline(width, pattern, false);
 
@@ -45,7 +45,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
         /// <param name="pattern">The pattern made of multiples of the width.</param>
         /// <param name="startOff">Weather the first item in the pattern is on or off.</param>
         /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Execute: Couldn't caculate Offset</exception>
+        /// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
         public static IPath GenerateOutline(this IPath path, float width, float[] pattern, bool startOff)
             => path.GenerateOutline(width, new ReadOnlySpan<float>(pattern), startOff);
 
@@ -57,7 +57,7 @@ public static IPath GenerateOutline(this IPath path, float width, float[] patter
         /// <param name="pattern">The pattern made of multiples of the width.</param>
         /// <param name="startOff">Weather the first item in the pattern is on or off.</param>
         /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Execute: Couldn't caculate Offset</exception>
+        /// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
         public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, bool startOff)
             => GenerateOutline(path, width, pattern, startOff, JointStyle.Square, EndCapStyle.Butt);
 
@@ -71,7 +71,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
         /// <param name="jointStyle">The style to render the joints.</param>
         /// <param name="patternSectionCapStyle">The style to render between sections of the specified pattern.</param>
         /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Execute: Couldn't caculate Offset</exception>
+        /// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
         public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<float> pattern, bool startOff, JointStyle jointStyle = JointStyle.Square, EndCapStyle patternSectionCapStyle = EndCapStyle.Butt)
         {
             if (pattern.Length < 2)
@@ -172,7 +172,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
         /// <param name="path">the path to outline</param>
         /// <param name="width">The final width outline</param>
         /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Execute: Couldn't caculate Offset</exception>
+        /// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
         public static IPath GenerateOutline(this IPath path, float width) => GenerateOutline(path, width, JointStyle.Square, EndCapStyle.Butt);
 
         /// <summary>
@@ -183,7 +183,7 @@ public static IPath GenerateOutline(this IPath path, float width, ReadOnlySpan<f
         /// <param name="jointStyle">The style to render the joints.</param>
         /// <param name="endCapStyle">The style to render the end caps of open paths (ignored on closed paths).</param>
         /// <returns>A new path representing the outline.</returns>
-        /// <exception cref="ClipperException">Execute: Couldn't caculate Offset</exception>
+        /// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
         public static IPath GenerateOutline(this IPath path, float width, JointStyle jointStyle = JointStyle.Square, EndCapStyle endCapStyle = EndCapStyle.Square)
         {
             var offset = new ClipperOffset(MiterOffsetDelta);

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

@@ -49,14 +49,7 @@ public IPath[] GenerateClippedShapes()
 
             lock (this.syncRoot)
             {
-                try
-                {
-                    this.innerClipper.Execute(ClipType.ctDifference, results);
-                }
-                catch (ClipperLib.ClipperException exception)
-                {
-                    throw new PolygonClipper.ClipperException(exception.Message);
-                }
+                this.innerClipper.Execute(ClipType.ctDifference, results);
             }
 
             var shapes = new IPath[results.Count];
@@ -151,14 +144,7 @@ internal void AddPath(ISimplePath path, ClippingType clippingType)
             PolyType type = clippingType == ClippingType.Clip ? PolyType.ptClip : PolyType.ptSubject;
             lock (this.syncRoot)
             {
-                try
-                {
-                    this.innerClipper.AddPath(points, type, path.IsClosed);
-                }
-                catch (ClipperLib.ClipperException exception)
-                {
-                    throw new PolygonClipper.ClipperException(exception.Message);
-                }
+                this.innerClipper.AddPath(points, type, path.IsClosed);
             }
         }
     }

src/ImageSharp.Drawing/Shapes/PolygonClipper/ClipperOffset.cs

@@ -30,20 +30,13 @@ internal class ClipperOffset
         /// </summary>
         /// <param name="width">Width</param>
         /// <returns>path offset</returns>
-        /// <exception cref="ClipperException">Execute: Couldn't caculate Offset</exception>
+        /// <exception cref="ClipperException">Calculate: Couldn't caculate Offset</exception>
         public ComplexPolygon Execute(float width)
         {
             var tree = new List<List<IntPoint>>();
             lock (this.syncRoot)
             {
-                try
-                {
-                    this.innerClipperOffest.Execute(ref tree, width * ScalingFactor / 2);
-                }
-                catch (ClipperLib.ClipperException exception)
-                {
-                    throw new PolygonClipper.ClipperException(exception.Message);
-                }
+                this.innerClipperOffest.Execute(ref tree, width * ScalingFactor / 2);
             }
 
             var polygons = new List<Polygon>();
@@ -113,14 +106,7 @@ private void AddPath(ReadOnlySpan<PointF> pathPoints, JointStyle jointStyle, End
 
             lock (this.syncRoot)
             {
-                try
-                {
-                    this.innerClipperOffest.AddPath(points, this.Convert(jointStyle), endCapStyle);
-                }
-                catch (ClipperLib.ClipperException exception)
-                {
-                    throw new PolygonClipper.ClipperException(exception.Message);
-                }
+                this.innerClipperOffest.AddPath(points, this.Convert(jointStyle), endCapStyle);
             }
         }
 

tests/ImageSharp.Drawing.Tests/Shapes/PolygonClipper/ClipperTests.cs

@@ -138,14 +138,13 @@ public void ClipperOffsetThrowsPublicException()
             PointF naan = new PointF(float.NaN, float.NaN);
             Polygon path = new Polygon(new LinearLineSegment(new[] { naan, naan, naan, naan }));
 
-            // Throws internal exception:
             try
             {
                 path.GenerateOutline(10);
             }
             catch (System.Exception ex)
             {
-                Assert.True(ex is ClipperException);
+                Assert.True(ex is ClipperLib.ClipperException);
             }
         }
     }