Commenting resetFields (especially that the params default to true)

closeio · Jul 25, 2013 · 6b54afd · 6b54afd
1 parent 593dc76
commit 6b54afd
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/jquery.autosave.js b/src/jquery.autosave.js
@@ -458,6 +458,17 @@
       }
     },
 
+    /**
+     * Reset the changed/modified bit on fields.
+     *
+     * @param {Boolean} [resetChanged]
+     *    Whether or not to reset which elements were changed before saving.
+     *    Defaults to true.
+     *
+     * @param {Boolean} [resetModified]
+     *    Whether or not to reset which elements were modified before saving.
+     *    Defaults to true.
+     */
     resetFields: function(resetChanged, resetModified) {
       // Reset changed by default
       if (resetChanged !== false) {