From dd321c5f4d0d238717a2bab50a28eeed83b22d5f Mon Sep 17 00:00:00 2001
From: Vojta Jina
Date: Wed, 22 Feb 2012 10:24:40 -0800
Subject: docs(scope): update $emit/$broadcast docs

---
 src/service/scope.js | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src')

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,
-- 
cgit v1.2.3