From: Jeanie Chung <jeanie.chung@gmail.com>
Date: Wed, 18 Feb 2015 02:41:04 +0000 (-0800)
Subject: Added some more documentation for various utility functions.
X-Git-Tag: v2.0.0-rc.1~134
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c77b8924dd4378471807eac8fd2b02f991c9d876;p=thirdparty%2Ffoundation%2Ffoundation-emails.git

Added some more documentation for various utility functions.
---

diff --git a/output/gulp-zurb-inky/index.js b/output/gulp-zurb-inky/index.js
index 4a3e5edf..04f0b273 100644
--- a/output/gulp-zurb-inky/index.js
+++ b/output/gulp-zurb-inky/index.js
@@ -41,6 +41,13 @@ Inky.prototype = {
     self.zfArray = arr;
   },
 
+  // Description:
+  //   Checks if an element is a custom ZF element.
+  //
+  // Arguments:
+  //    elType (string): the tag name of an element
+  // Returns:
+  //    boolean: true/false
   isZfElement: function(elType) {
     var self = this;
     // create an array of our custom tags, if we haven't done so already
@@ -58,6 +65,14 @@ Inky.prototype = {
     }
   },
 
+  // Description:
+  //   Checks if an element is an element with a td included. Currently it's a manual check. 
+  //   Array was populated from the markup from the component factory.
+  //
+  // Arguments:
+  //    elType (string): the tag name of an element
+  // Returns:
+  //    boolean: true/false
   isTdElement: function(elType) {
     var tdEls = ['subcolumns', 'callout']
 
@@ -73,9 +88,9 @@ Inky.prototype = {
   },
 
   // Description:
-  //   Takes in HTML loaded via Cheerio as an argument, checks if there are any custom components.
-  //   If there are, it replaces the nested components, traverses the DOM and replaces them with
-  //   email markup.
+  //   Awww yiss. Kickstarts the whole parser. Takes in HTML loaded via Cheerio as an argument, 
+  //   checks if there are any custom components. If there are, it replaces the nested components, 
+  //   traverses the DOM and replaces them with email markup.
   //
   // Arguments:
   //    $: Cheerio loaded string