Added function documentation/summaries

Author: codebude

QRCoder/ArtQRCode.cs

@@ -14,18 +14,45 @@ public class ArtQRCode : AbstractQRCode, IDisposable
         /// </summary>
         public ArtQRCode() { }
 
+        /// <summary>
+        /// Creates new ArtQrCode object
+        /// </summary>
+        /// <param name="data">QRCodeData generated by the QRCodeGenerator</param>
         public ArtQRCode(QRCodeData data) : base(data) { }
 
+        /// <summary>
+        /// Renders an art-style QR code with dots as modules. (With default settings: DarkColor=Black, LightColor=White, Background=Transparent, QuietZone=true)
+        /// </summary>
+        /// <param name="pixelsPerModule">Amount of px each dark/light module of the QR code shall take place in the final QR code image</param>
+        /// <returns>QRCode graphic as bitmap</returns>
         public Bitmap GetGraphic(int pixelsPerModule)
         {
             return this.GetGraphic(pixelsPerModule, Color.Black, Color.White, Color.Transparent);
         }
 
+        /// <summary>
+        /// Renders an art-style QR code with dots as modules and a background image (With default settings: DarkColor=Black, LightColor=White, Background=Transparent, QuietZone=true)
+        /// </summary>
+        /// <param name="backgroundImage">A bitmap object that will be used as background picture</param>
+        /// <returns>QRCode graphic as bitmap</returns>
         public Bitmap GetGraphic(Bitmap backgroundImage = null)
         {
             return this.GetGraphic(10, Color.Black, Color.White, Color.Transparent, backgroundImage: backgroundImage);
         }
 
+        /// <summary>
+        /// Renders an art-style QR code with dots as modules and various user settings
+        /// </summary>
+        /// <param name="pixelsPerModule">Amount of px each dark/light module of the QR code shall take place in the final QR code image</param>
+        /// <param name="darkColor">Color of the dark modules</param>
+        /// <param name="lightColor">Color of the light modules</param>
+        /// <param name="backgroundColor">Color of the background</param>
+        /// <param name="backgroundImage">A bitmap object that will be used as background picture</param>
+        /// <param name="pixelSizeFactor">Value between 0.0 to 1.0 that defines how big the module dots are. The bigger the value, the less round the dots will be.</param>
+        /// <param name="drawQuietZones">If true a white border is drawn around the whole QR Code</param>
+        /// <param name="quietZoneRenderingStyle">Style of the quiet zones</param>
+        /// <param name="finderPatternImage">Optional image that should be used instead of the default finder patterns</param>
+        /// <returns>QRCode graphic as bitmap</returns>
         public Bitmap GetGraphic(int pixelsPerModule, Color darkColor, Color lightColor, Color backgroundColor, Bitmap backgroundImage = null, double pixelSizeFactor = 0.8, 
                                  bool drawQuietZones = true, QuietZoneStyle quietZoneRenderingStyle = QuietZoneStyle.Flat, Bitmap finderPatternImage = null)
         {
@@ -74,15 +101,13 @@ public Bitmap GetGraphic(int pixelsPerModule, Color darkColor, Color lightColor,
                                     graphics.FillRectangle(solidBrush, rectangleF);
                             }
                         }
-
                         if (finderPatternImage != null)
                         {
                             var finderPatternSize = 7 * pixelsPerModule;
                             graphics.DrawImage(finderPatternImage, new Rectangle(0, 0, finderPatternSize, finderPatternSize));
                             graphics.DrawImage(finderPatternImage, new Rectangle(size - finderPatternSize, 0, finderPatternSize, finderPatternSize));
                             graphics.DrawImage(finderPatternImage, new Rectangle(0, size - finderPatternSize, finderPatternSize, finderPatternSize));
                         }
-
                         graphics.Save();
                     }
                 }
@@ -93,9 +118,9 @@ public Bitmap GetGraphic(int pixelsPerModule, Color darkColor, Color lightColor,
         /// <summary>
         /// If the pixelSize is bigger than the pixelsPerModule or may end up filling the Module making a traditional QR code.
         /// </summary>
-        /// <param name="pixelsPerModule"></param>
-        /// <param name="pixelSize"></param>
-        /// <param name="brush"></param>
+        /// <param name="pixelsPerModule">Pixels used per module rendered</param>
+        /// <param name="pixelSize">Size of the dots</param>
+        /// <param name="brush">Color of the pixels</param>
         /// <returns></returns>
         private Bitmap MakeDotPixel(int pixelsPerModule, int pixelSize, SolidBrush brush)
         {            
@@ -124,6 +149,13 @@ private Bitmap MakeDotPixel(int pixelsPerModule, int pixelSize, SolidBrush brush
         }
 
 
+        /// <summary>
+        /// Checks if a given module(-position) is part of the quietzone of a QR code
+        /// </summary>
+        /// <param name="x">X position</param>
+        /// <param name="y">Y position</param>
+        /// <param name="numModules">Total number of modules per row</param>
+        /// <returns>true, if position is part of quiet zone</returns>
         private bool IsPartOfQuietZone(int x, int y, int numModules)
         {
             return
@@ -134,6 +166,14 @@ private bool IsPartOfQuietZone(int x, int y, int numModules)
         }
 
 
+        /// <summary>
+        /// Checks if a given module(-position) is part of one of the three finder patterns of a QR code
+        /// </summary>
+        /// <param name="x">X position</param>
+        /// <param name="y">Y position</param>
+        /// <param name="numModules">Total number of modules per row</param>
+        /// <param name="offset">Offset in modules (usually depending on drawQuietZones parameter)</param>
+        /// <returns>true, if position is part of any finder pattern</returns>
         private bool IsPartOfFinderPattern(int x, int y, int numModules, int offset)
         {
             var cornerSize = 11 - offset;
@@ -149,10 +189,9 @@ private bool IsPartOfFinderPattern(int x, int y, int numModules, int offset)
         /// <summary>
         /// Resize to a square bitmap, but maintain the aspect ratio by padding transparently.
         /// </summary>
-        /// 
         /// <param name="image"></param>
         /// <param name="newSize"></param>
-        /// <returns></returns>
+        /// <returns>Resized image as bitmap</returns>
         private Bitmap Resize(Bitmap image, int newSize)
         {
             if (image == null) return null;
@@ -183,6 +222,9 @@ private Bitmap Resize(Bitmap image, int newSize)
             return bm;
         }
 
+        /// <summary>
+        /// Defines how the quiet zones shall be rendered.
+        /// </summary>
         public enum QuietZoneStyle
         {
             Dotted,