docs($rootScope): fix $on listener signature doc

unirgy · IgorMinar · commit 4ccd9eb88321 · 2012-08-10T14:50:22.000-07:00
Added args in $on() listener syntax declaration
diff --git a/src/ng/rootScope.js b/src/ng/rootScope.js
@@ -614,8 +614,8 @@ function $RootScopeProvider(){
        * @param {function(event)} listener Function to call when the event is emitted.
        * @returns {function()} Returns a deregistration function for this listener.
        *
-       * The event listener function format is: `function(event)`. The `event` object passed into the
-       * listener has the following attributes
+       * The event listener function format is: `function(event, args...)`. The `event` object
+       * passed into the listener has the following attributes:
        *
        *   - `targetScope` - {Scope}: the scope on which the event was `$emit`-ed or `$broadcast`-ed.
        *   - `currentScope` - {Scope}: the current scope which is handling the event.

Original file line number	Diff line number	Diff line change
`@@ -614,8 +614,8 @@ function $RootScopeProvider(){`
`614`	`614`	`* @param {function(event)} listener Function to call when the event is emitted.`
`615`	`615`	`* @returns {function()} Returns a deregistration function for this listener.`
`616`	`616`	`*`
`617`		- * The event listener function format is: `function(event)`. The `event` object passed into the
`618`		`- * listener has the following attributes`
	`617`	+ * The event listener function format is: `function(event, args...)`. The `event` object
	`618`	`+ * passed into the listener has the following attributes:`
`619`	`619`	`*`
`620`	`620`	* - `targetScope` - {Scope}: the scope on which the event was `$emit`-ed or `$broadcast`-ed.
`621`	`621`	* - `currentScope` - {Scope}: the current scope which is handling the event.