From d126f618ae59c2b5794e68dc627db7699b876dd8 Mon Sep 17 00:00:00 2001
From: Mike Gerwitz <gerwitm@lovullo.com>
Date: Fri, 1 Apr 2016 16:00:30 -0400
Subject: [PATCH] Add FieldStyler docblocks

* src/ui/styler/FieldStyler.js (getId, applyStyle, revokeStyle,
addClass, removeClass): Docblocks added
---
 src/ui/styler/FieldStyler.js | 49 +++++++++++++++++++++++++++++++++++-
 1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/src/ui/styler/FieldStyler.js b/src/ui/styler/FieldStyler.js
index f535e30..7ed5cfe 100644
--- a/src/ui/styler/FieldStyler.js
+++ b/src/ui/styler/FieldStyler.js
@@ -23,17 +23,53 @@ var AbstractClass = require( 'easejs' ).AbstractClass;
 
 
 /**
- * Style fields using CSS
+ * Style DOM fields
+ *
+ * @todo perhaps this should be called DomFieldStyler
  */
 module.exports = AbstractClass( 'FieldStyler',
 {
+    /**
+     * Retrieve unique identifier
+     *
+     * @return {string} unique identifier
+     */
     'abstract public getId': [],
 
+    /**
+     * Apply style to field
+     *
+     * @param {DomField}            field   field to style
+     * @param {HTMLElement}         element DOM element to style
+     * @param {Array.<HTMLElement>} row     DOM elements of containing row
+     *
+     * @return {FieldStyler} self
+     */
     'abstract public applyStyle': [ 'field', 'element', 'row' ],
 
+    /**
+     * Remove style from field
+     *
+     * @param {DomField}            field   field to unstyle
+     * @param {HTMLElement}         element DOM element to unstyle
+     * @param {Array.<HTMLElement>} row     DOM elements of containing row
+     *
+     * @return {FieldStyler} self
+     */
     'abstract public revokeStyle': [ 'field', 'element', 'row' ],
 
 
+    /**
+     * Add CSS class CLS to element ELEMENT
+     *
+     * This method is needed until support is dropped for browsers that do
+     * not support classList.
+     *
+     * @param {HTMLElement} element DOM element to style
+     * @param {string}      cls     class name
+     *
+     * @return {FieldStyler} self
+     */
     'protected addClass': function( element, cls )
     {
         if ( !element )
@@ -60,6 +96,17 @@ module.exports = AbstractClass( 'FieldStyler',
     },
 
 
+    /**
+     * Add CSS class CLS to element ELEMENT
+     *
+     * This method is needed until support is dropped for browsers that do
+     * not support classList.
+     *
+     * @param {HTMLElement} element DOM element to style
+     * @param {string}      cls     class name
+     *
+     * @return {FieldStyler} self
+     */
     'protected removeClass': function( element, cls )
     {
         if ( !element )