1 files changed, 94 insertions, 33 deletions
diff --git a/jquery.once.js b/jquery.once.js
index a547c1a..d946eb3 100644
--- a/jquery.once.js
+++ b/jquery.once.js
@@ -1,38 +1,99 @@
 // Generated by CoffeeScript 1.8.0
-(function() {
-  (function(factory) {
-    if (typeof exports === "object") {
-      factory(require("jquery"));
-    } else if (typeof define === "function" && define.amd) {
-      define(["jquery"], factory);
-    } else {
-      factory(jQuery);
+
+/*
+ * jQuery Once `2.0.0-alpha.10`
+ * http://github.com/robloach/jquery-once
+ *
+ * Act on jQuery elements only once.
+ *
+ * - [MIT](http://www.opensource.org/licenses/mit-license.php)
+ * - [GPL-2.0](http://www.gnu.org/licenses/gpl.html)
+ */
+
+/*
+ * Universal Module Definition
+ *
+ * [jQuery](http://jquery.com) is a dependency, so we wrap the code with a
+ * [UMD](https://github.com/umdjs/umd) pattern in order to allow loading jQuery,
+ * and jQuery Once, using [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD),
+ * [CommonJS](http://en.wikipedia.org/wiki/CommonJS), or as a global variable.
+ */
+(function(umd) {
+  if (typeof exports === "object") {
+    return umd(require("jquery"));
+  }
+  if (typeof define === "function" && define.amd) {
+    return define(["jquery"], umd);
+  }
+  return umd(jQuery);
+})(function($) {
+
+  /*
+   * Filter elements by whether they have not yet been processed.
+   *
+   * @param {string} id - The data id used to determine whether the given
+   * elements have already been processed or not.
+   *
+   * @return jQuery element collection of elements that have now run once by the
+   * given id.
+   *
+   * @example
+   * // Change the color of the text to green.
+   * $('p').once('changecolor').css('color', 'green');
+   */
+  $.fn.once = function(id) {
+    var name;
+    if (!id) {
+      throw new Error("An ID is required when calling jQuery.once()");
     }
-  })(function($) {
-    var uuid;
-    uuid = 0;
-    $.fn.once = function(id) {
-      var name;
-      if (!id) {
-        throw new Error("An ID is required when calling jQuery.once()");
-      }
-      name = "jquery-once-" + id;
-      return this.filter(function() {
-        return $(this).data(name) !== true;
-      }).data(name, true);
-    };
-    $.fn.removeOnce = function(id) {
-      return this.findOnce(id).removeData("jquery-once-" + id);
-    };
-    $.fn.findOnce = function(id) {
-      var name;
-      name = "jquery-once-" + id;
-      return this.filter(function() {
-        return $(this).data(name) === true;
-      });
-    };
-  });
+    name = "jquery-once-" + id;
+    return this.filter(function() {
+      return $(this).data(name) !== true;
+    }).data(name, true);
+  };
+
+  /*
+   * Removes the once data from the given elements, based on the given ID.
+   *
+   * @param {string} id - A required string representing the name of the data id
+   * which should be used when filtering the elements. This only filters elements
+   * that have already been processed by the once function. The id should be the
+   * same id that was originally passed to the `.once()` function.
+   *
+   * @return jQuery element collection that had their `once` data removed.
+   * @example
+   * // Remove the once
+   * $('p').removeOnce('changecolor').each(function() {
+   *   // This function is run for each element that had its once data removed.
+   * });
+   */
+  $.fn.removeOnce = function(id) {
+    return this.findOnce(id).removeData("jquery-once-" + id);
+  };
 
-}).call(this);
+  /*
+   * Filters elements that have already been processed once.
+   *
+   * @param {string} id - A required string representing the name of the data id
+   * which should be used when filtering the elements. This only filters elements
+   * that have already been processed by the once function. The id should be the
+   * same id that was originally passed to the `.once()` function.
+   *
+   * @return jQuery element collection of elements that have been run once.
+   *
+   * @example
+   * // Remove the once
+   * $('p').findOnce('changecolor').each(function() {
+   *   // This function is run for each element that has already been run once.
+   * });
+   */
+  return $.fn.findOnce = function(id) {
+    var name;
+    name = "jquery-once-" + id;
+    return this.filter(function() {
+      return $(this).data(name) === true;
+    });
+  };
+});
 
 //# sourceMappingURL=jquery.once.js.map