From e6d129646b3f05e08d61cd1b050403ba378da164 Mon Sep 17 00:00:00 2001
From: Scott Williams <tocsoft@gmail.com>
Date: Sat, 25 Mar 2017 07:07:58 +0000
Subject: [PATCH] Improve method name

Added comments too
---
 .../Formats/Png/PngSmokeTests.cs              |  6 +--
 tests/ImageSharp.Tests/ImageComparer.cs       |  2 +-
 .../ImageProviders/TestPatternProvider.cs     | 39 +++++++++++++++----
 3 files changed, 36 insertions(+), 11 deletions(-)

diff --git a/tests/ImageSharp.Tests/Formats/Png/PngSmokeTests.cs b/tests/ImageSharp.Tests/Formats/Png/PngSmokeTests.cs
index d4e8534a7..924903039 100644
--- a/tests/ImageSharp.Tests/Formats/Png/PngSmokeTests.cs
+++ b/tests/ImageSharp.Tests/Formats/Png/PngSmokeTests.cs
@@ -32,7 +32,7 @@ namespace ImageSharp.Tests.Formats.Png
                 using (Image img2 = new Image(ms, new Configuration(new PngFormat())))
                 {
                     // img2.Save(provider.Utility.GetTestOutputFileName("bmp", "_loaded"), new BmpEncoder());
-                    ImageComparer.VisualComparer(image, img2);
+                    ImageComparer.CheckSimilarity(image, img2);
                 }
             }
         }
@@ -53,7 +53,7 @@ namespace ImageSharp.Tests.Formats.Png
                 using (Image img2 = new Image(ms, new Configuration(new PngFormat())))
                 {
                     // img2.Save(provider.Utility.GetTestOutputFileName("bmp", "_loaded"), new BmpEncoder());
-                    ImageComparer.VisualComparer(image, img2);
+                    ImageComparer.CheckSimilarity(image, img2);
                 }
             }
         }
@@ -75,7 +75,7 @@ namespace ImageSharp.Tests.Formats.Png
                 ms.Position = 0;
                 using (Image img2 = new Image(ms, new Configuration(new PngFormat())))
                 {
-                    ImageComparer.VisualComparer(image, img2);
+                    ImageComparer.CheckSimilarity(image, img2);
                 }
             }
         }
diff --git a/tests/ImageSharp.Tests/ImageComparer.cs b/tests/ImageSharp.Tests/ImageComparer.cs
index 0462506a6..41b884dd4 100644
--- a/tests/ImageSharp.Tests/ImageComparer.cs
+++ b/tests/ImageSharp.Tests/ImageComparer.cs
@@ -32,7 +32,7 @@
         /// This is a sampling factor we sample a grid of average pixels <paramref name="scalingFactor"/> width by <paramref name="scalingFactor"/> high
         /// The default undefined value is <see cref="ImageComparer.DefaultScalingFactor"/>
         /// </param>
-        public static void VisualComparer<TColorA, TColorB>(Image<TColorA> expected, Image<TColorB> actual, float imageTheshold = DefaultImageThreshold, byte segmentThreshold = DefaultSegmentThreshold, int scalingFactor = DefaultScalingFactor)
+        public static void CheckSimilarity<TColorA, TColorB>(Image<TColorA> expected, Image<TColorB> actual, float imageTheshold = DefaultImageThreshold, byte segmentThreshold = DefaultSegmentThreshold, int scalingFactor = DefaultScalingFactor)
            where TColorA : struct, IPixel<TColorA>
            where TColorB : struct, IPixel<TColorB>
         {
diff --git a/tests/ImageSharp.Tests/TestUtilities/ImageProviders/TestPatternProvider.cs b/tests/ImageSharp.Tests/TestUtilities/ImageProviders/TestPatternProvider.cs
index 7e4401635..89f46a947 100644
--- a/tests/ImageSharp.Tests/TestUtilities/ImageProviders/TestPatternProvider.cs
+++ b/tests/ImageSharp.Tests/TestUtilities/ImageProviders/TestPatternProvider.cs
@@ -12,6 +12,11 @@ namespace ImageSharp.Tests
     public abstract partial class TestImageProvider<TColor>
         where TColor : struct, IPixel<TColor>
     {
+
+        /// <summary>
+        /// A test image provider that produces test patterns.
+        /// </summary>
+        /// <typeparam name="TColor"></typeparam>
         private class TestPatternProvider : TestImageProvider<TColor>
         {
             static Dictionary<string, Image<TColor>> testImages = new Dictionary<string, Image<TColor>>();
@@ -43,19 +48,26 @@ namespace ImageSharp.Tests
                 }
             }
 
+            /// <summary>
+            /// Draws the test pattern on an image by drawing 4 other patterns in the for quadrants of the image.
+            /// </summary>
+            /// <param name="image"></param>
             private static void DrawTestPattern(Image<TColor> image)
             {
                 // first lets split the image into 4 quadrants
                 using (PixelAccessor<TColor> pixels = image.Lock())
                 {
                     BlackWhiteChecker(pixels); // top left
-                    HorizontalLines(pixels); // top right
+                    VirticalBars(pixels); // top right
                     TransparentGradients(pixels); // bottom left
-                    Raninbow(pixels); // bottom right 
+                    Rainbow(pixels); // bottom right 
                 }
             }
-
-            private static void HorizontalLines(PixelAccessor<TColor> pixels)
+            /// <summary>
+            /// Fills the top right quadrant with alternating solid vertical bars.
+            /// </summary>
+            /// <param name="pixels"></param>
+            private static void VirticalBars(PixelAccessor<TColor> pixels)
             {
                 // topLeft 
                 int left = pixels.Width / 2;
@@ -82,6 +94,10 @@ namespace ImageSharp.Tests
                 }
             }
 
+            /// <summary>
+            /// fills the top left quadrant with a black and white checker board.
+            /// </summary>
+            /// <param name="pixels"></param>
             private static void BlackWhiteChecker(PixelAccessor<TColor> pixels)
             {
                 // topLeft 
@@ -116,7 +132,11 @@ namespace ImageSharp.Tests
                     p = pstart;
                 }
             }
-
+            
+            /// <summary>
+            /// Fills the bottom left quadrent with 3 horizental bars in Red, Green and Blue with a alpha gradient from left (transparent) to right (solid).
+            /// </summary>
+            /// <param name="pixels"></param>
             private static void TransparentGradients(PixelAccessor<TColor> pixels)
             {
                 // topLeft 
@@ -155,9 +175,14 @@ namespace ImageSharp.Tests
                         pixels[x, y] = c;
                     }
                 }
-
             }
-            private static void Raninbow(PixelAccessor<TColor> pixels)
+
+            /// <summary>
+            /// Fills the bottom right quadrant with all the colors producable by converting itterating over a uint and unpacking it.
+            /// A better algorithm could be used but it works
+            /// </summary>
+            /// <param name="pixels"></param>
+            private static void Rainbow(PixelAccessor<TColor> pixels)
             {
                 int left = pixels.Width / 2;
                 int right = pixels.Width;