github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

Updated some doc blocks

Browse source
This commit is contained in:
Spencer Alger 2014-08-06 15:19:58 -07:00
parent d650cf92a4
commit ac6bafab25
1 changed files with 12 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

23
src/kibana/factories/events.js
View file

@ -13,9 +13,9 @@ define(function (require) {
/**
* Listens for events
* @param {string} name The name of the event
* @param {function} handler The handler for the event
* @returns {PromiseEmitter}
* @param {string} name - The name of the event
* @param {function} handler - The function to call when the event is triggered
* @returns {undefined}
*/
Events.prototype.on = function (name, handler) {
if (!_.isArray(this._listeners[name])) {
@ -38,10 +38,10 @@ define(function (require) {
};
/**
* Removes a event listner
* @param {string} name The name of the event
* @param {function} [handler] The handler to remove
* @return {void}
* Removes an event listener
* @param {string} [name] - The name of the event
* @param {function} [handler] - The handler to remove
* @return {undefined}
*/
Events.prototype.off = function (name, handler) {
if (!name && !handler) {
@ -62,10 +62,11 @@ define(function (require) {
};
/**
* Emits and event using the PromiseEmitter
* @param {string} name The name of the event
* @param {mixed} args The args to pass along to the handers
* @returns {void}
* Emits the event to all listeners
*
* @param {string} name - The name of the event.
* @param {any} [value] - The value that will be passed to all event handlers.
* @returns {Promise}
*/
Events.prototype.emit = function (name, value) {
if (!this._listeners[name]) {