Added code documentation/summary

Author: codebude

QRCoder/SvgQRCode.cs

@@ -19,11 +19,27 @@ public class SvgQRCode : AbstractQRCode, IDisposable
         public SvgQRCode() { }
         public SvgQRCode(QRCodeData data) : base(data) { }
 
+        /// <summary>
+        /// Returns a QR code as SVG string
+        /// </summary>
+        /// <param name="pixelsPerModule">The pixel size each b/w module is drawn</param>
+        /// <returns>SVG as string</returns>
         public string GetGraphic(int pixelsPerModule)
         {
             var viewBox = new Size(pixelsPerModule*this.QrCodeData.ModuleMatrix.Count, pixelsPerModule * this.QrCodeData.ModuleMatrix.Count);
             return this.GetGraphic(viewBox, Color.Black, Color.White);
         }
+
+        /// <summary>
+        /// Returns a QR code as SVG string with custom colors, optional quietzone and logo
+        /// </summary>
+        /// <param name="pixelsPerModule">The pixel size each b/w module is drawn</param>
+        /// <param name="darkColor">Color of the dark modules</param>
+        /// <param name="lightColor">Color of the light modules</param>
+        /// <param name="drawQuietZones">If true a white border is drawn around the whole QR Code</param>
+        /// <param name="sizingMode">Defines if width/height or viewbox should be used for size definition</param>
+        /// <param name="logo">A (optional) logo to be rendered on the code (either Bitmap or SVG)</param>
+        /// <returns>SVG as string</returns>
         public string GetGraphic(int pixelsPerModule, Color darkColor, Color lightColor, bool drawQuietZones = true, SizingMode sizingMode = SizingMode.WidthHeightAttribute, SvgLogo logo = null)
         {
             var offset = drawQuietZones ? 0 : 4;
@@ -32,6 +48,16 @@ public string GetGraphic(int pixelsPerModule, Color darkColor, Color lightColor,
             return this.GetGraphic(viewBox, darkColor, lightColor, drawQuietZones, sizingMode, logo);
         }
 
+        /// <summary>
+        /// Returns a QR code as SVG string with custom colors (in HEX syntax), optional quietzone and logo
+        /// </summary>
+        /// <param name="pixelsPerModule">The pixel size each b/w module is drawn</param>
+        /// <param name="darkColorHex">The color of the dark/black modules in hex (e.g. #000000) representation</param>
+        /// <param name="lightColorHex">The color of the light/white modules in hex (e.g. #ffffff) representation</param>
+        /// <param name="drawQuietZones">If true a white border is drawn around the whole QR Code</param>
+        /// <param name="sizingMode">Defines if width/height or viewbox should be used for size definition</param>
+        /// <param name="logo">A (optional) logo to be rendered on the code (either Bitmap or SVG)</param>
+        /// <returns>SVG as string</returns>
         public string GetGraphic(int pixelsPerModule, string darkColorHex, string lightColorHex, bool drawQuietZones = true, SizingMode sizingMode = SizingMode.WidthHeightAttribute, SvgLogo logo = null)
         {
             var offset = drawQuietZones ? 0 : 4;
@@ -40,16 +66,44 @@ public string GetGraphic(int pixelsPerModule, string darkColorHex, string lightC
             return this.GetGraphic(viewBox, darkColorHex, lightColorHex, drawQuietZones, sizingMode, logo);
         }
 
+        /// <summary>
+        /// Returns a QR code as SVG string with optional quietzone and logo
+        /// </summary>
+        /// <param name="viewBox">The viewbox of the QR code graphic</param>
+        /// <param name="drawQuietZones">If true a white border is drawn around the whole QR Code</param>
+        /// <param name="sizingMode">Defines if width/height or viewbox should be used for size definition</param>
+        /// <param name="logo">A (optional) logo to be rendered on the code (either Bitmap or SVG)</param>
+        /// <returns>SVG as string</returns>
         public string GetGraphic(Size viewBox, bool drawQuietZones = true, SizingMode sizingMode = SizingMode.WidthHeightAttribute, SvgLogo logo = null)
         {
             return this.GetGraphic(viewBox, Color.Black, Color.White, drawQuietZones, sizingMode, logo);
         }
 
+        /// <summary>
+        /// Returns a QR code as SVG string with custom colors and optional quietzone and logo
+        /// </summary>
+        /// <param name="viewBox">The viewbox of the QR code graphic</param>
+        /// <param name="darkColor">Color of the dark modules</param>
+        /// <param name="lightColor">Color of the light modules</param>
+        /// <param name="drawQuietZones">If true a white border is drawn around the whole QR Code</param>
+        /// <param name="sizingMode">Defines if width/height or viewbox should be used for size definition</param>
+        /// <param name="logo">A (optional) logo to be rendered on the code (either Bitmap or SVG)</param>
+        /// <returns>SVG as string</returns>
         public string GetGraphic(Size viewBox, Color darkColor, Color lightColor, bool drawQuietZones = true, SizingMode sizingMode = SizingMode.WidthHeightAttribute, SvgLogo logo = null)
         {
             return this.GetGraphic(viewBox, ColorTranslator.ToHtml(Color.FromArgb(darkColor.ToArgb())), ColorTranslator.ToHtml(Color.FromArgb(lightColor.ToArgb())), drawQuietZones, sizingMode, logo);
         }
 
+        /// <summary>
+        /// Returns a QR code as SVG string with custom colors (in HEX syntax), optional quietzone and logo
+        /// </summary>
+        /// <param name="viewBox">The viewbox of the QR code graphic</param>
+        /// <param name="darkColorHex">The color of the dark/black modules in hex (e.g. #000000) representation</param>
+        /// <param name="lightColorHex">The color of the light/white modules in hex (e.g. #ffffff) representation</param>
+        /// <param name="drawQuietZones">If true a white border is drawn around the whole QR Code</param>
+        /// <param name="sizingMode">Defines if width/height or viewbox should be used for size definition</param>
+        /// <param name="logo">A (optional) logo to be rendered on the code (either Bitmap or SVG)</param>
+        /// <returns>SVG as string</returns>
         public string GetGraphic(Size viewBox, string darkColorHex, string lightColorHex, bool drawQuietZones = true, SizingMode sizingMode = SizingMode.WidthHeightAttribute, SvgLogo logo = null)
         {
             int offset = drawQuietZones ? 0 : 4;
@@ -194,26 +248,33 @@ private string CleanSvgVal(double input)
             return input.ToString(System.Globalization.CultureInfo.InvariantCulture);
         }
 
+        /// <summary>
+        /// Mode of sizing attribution on svg root node
+        /// </summary>
         public enum SizingMode
         {
             WidthHeightAttribute,
             ViewBoxAttribute
         }
 
+        /// <summary>
+        /// Represents a logo graphic that can be rendered on a SvgQRCode
+        /// </summary>
         public class SvgLogo
         {
             private string _logoData;
             private MediaType _mediaType;
             private int _iconSizePercent;
             private bool _fillLogoBackground;
             private object _logoRaw;
-             
 
+          
             /// <summary>
             /// Create a logo object to be used in SvgQRCode renderer
             /// </summary>
             /// <param name="iconRasterized">Logo to be rendered as Bitmap/rasterized graphic</param>
             /// <param name="iconSizePercent">Degree of percentage coverage of the QR code by the logo</param>
+            /// <param name="fillLogoBackground">If true, the background behind the logo will be cleaned</param>
             public SvgLogo(Bitmap iconRasterized, int iconSizePercent = 15, bool fillLogoBackground = true)
             {
                 _iconSizePercent = iconSizePercent;
@@ -235,6 +296,7 @@ public SvgLogo(Bitmap iconRasterized, int iconSizePercent = 15, bool fillLogoBac
             /// </summary>
             /// <param name="iconVectorized">Logo to be rendered as SVG/vectorized graphic/string</param>
             /// <param name="iconSizePercent">Degree of percentage coverage of the QR code by the logo</param>
+            /// <param name="fillLogoBackground">If true, the background behind the logo will be cleaned</param>
             public SvgLogo(string iconVectorized, int iconSizePercent = 15, bool fillLogoBackground = true)
             {
                 _iconSizePercent = iconSizePercent;
@@ -244,30 +306,54 @@ public SvgLogo(string iconVectorized, int iconSizePercent = 15, bool fillLogoBac
                 _logoRaw = iconVectorized;
             }
 
+            /// <summary>
+            /// Returns the raw logo's data
+            /// </summary>
+            /// <returns></returns>
             public object GetRawLogo()
             {
                 return _logoRaw;
             }
 
+            /// <summary>
+            /// Returns the media type of the logo
+            /// </summary>
+            /// <returns></returns>
             public MediaType GetMediaType()
             {
                 return _mediaType;
             }
 
+            /// <summary>
+            /// Returns the logo as data-uri
+            /// </summary>
+            /// <returns></returns>
             public string GetDataUri()
             {
                 return $"data:{_mediaType.GetStringValue()};base64,{_logoData}";
             }
 
+            /// <summary>
+            /// Returns how much of the QR code should be covered by the logo (in percent)
+            /// </summary>
+            /// <returns></returns>
             public int GetIconSizePercent()
             {
                 return _iconSizePercent;
             }
+
+            /// <summary>
+            /// Returns if the background of the logo should be cleaned (no QR modules will be rendered behind the logo)
+            /// </summary>
+            /// <returns></returns>
             public bool FillLogoBackground()
             {
                 return _fillLogoBackground;
             }
 
+            /// <summary>
+            /// Media types for SvgLogos
+            /// </summary>
             public enum MediaType : int
             {
                 [StringValue("image/png")]