aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVojta Jina2012-02-22 10:24:40 -0800
committerVojta Jina2012-02-22 10:24:40 -0800
commitdd321c5f4d0d238717a2bab50a28eeed83b22d5f (patch)
treee16d9fc4d4d63a8ece318a1d32c635e758d34de8
parent656a495e503bc0a5a8e1b2da0169e6d2bf0f31f1 (diff)
downloadangular.js-dd321c5f4d0d238717a2bab50a28eeed83b22d5f.tar.bz2
docs(scope): update $emit/$broadcast docs
-rw-r--r--src/service/scope.js3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/service/scope.js b/src/service/scope.js
index da1062a8..2d2f7fec 100644
--- a/src/service/scope.js
+++ b/src/service/scope.js
@@ -563,6 +563,7 @@ function $RootScopeProvider(){
* - `name` - {string}: Name of the event.
* - `cancel` - {function=}: calling `cancel` function will cancel further event propagation
* (available only for events that were `$emit`-ed).
+ * - `cancelled` - {boolean}: Whether the event was cancelled.
*/
$on: function(name, listener) {
var namedListeners = this.$$listeners[name];
@@ -597,6 +598,7 @@ function $RootScopeProvider(){
*
* @param {string} name Event name to emit.
* @param {...*} args Optional set of arguments which will be passed onto the event listeners.
+ * @return {Object} Event object, see {@link angular.module.ng.$rootScope.Scope#$on}
*/
$emit: function(name, args) {
var empty = [],
@@ -650,6 +652,7 @@ function $RootScopeProvider(){
*
* @param {string} name Event name to emit.
* @param {...*} args Optional set of arguments which will be passed onto the event listeners.
+ * @return {Object} Event object, see {@link angular.module.ng.$rootScope.Scope#$on}
*/
$broadcast: function(name, args) {
var target = this,