Add @method docblocks

YahooArchive · Aug 15, 2014 · 16d00d2 · 16d00d2
1 parent 44ff5ef
commit 16d00d2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/utils/BaseStore.js b/utils/BaseStore.js
@@ -10,6 +10,7 @@ var util = require('util'),
 
 /**
  * @class BaseStore
+ * @extends EventEmitter
  * @param dispatcher The dispatcher interface
  * @constructor
  */
@@ -24,6 +25,7 @@ util.inherits(BaseStore, EventEmitter);
 
 /**
  * Add a listener for the change event
+ * @method addChangeListener
  * @param {Function} callback
  */
 BaseStore.prototype.addChangeListener = function(callback) {
@@ -32,6 +34,7 @@ BaseStore.prototype.addChangeListener = function(callback) {
 
 /**
  * Remove a listener for the change event
+ * @method removeChangeListener
  * @param {Function} callback
  */
 BaseStore.prototype.removeChangeListener = function(callback) {
@@ -40,9 +43,10 @@ BaseStore.prototype.removeChangeListener = function(callback) {
 
 /**
  * Emit a change event
+ * @method emitChange
  */
 BaseStore.prototype.emitChange = function() {
   this.emit(CHANGE_EVENT);
 };
 
-module.exports = BaseStore;
+module.exports = BaseStore;
diff --git a/utils/createStore.js b/utils/createStore.js
@@ -10,6 +10,7 @@ var util = require('util'),
 
 /**
  * Helper for creating a store class
+ * @method createStore
  * @param {Object} spec
  * @param {String} spec.storeName The name of the store
  * @param {Object} spec.handlers Hash of action name to method name of action handlers
@@ -44,4 +45,4 @@ module.exports = function createStore(spec) {
     });
 
     return Store;
-};
+};