docs($scope): clarify documentation for $broadcast

willtj · petebacondarwin · commit bffe6fa8a60d · 2013-05-10T21:24:08.000+01:00
diff --git a/src/ng/rootScope.js b/src/ng/rootScope.js
@@ -862,7 +862,7 @@ function $RootScopeProvider(){
        * Any exception emitted from the {@link ng.$rootScope.Scope#$on listeners} will be passed
        * onto the {@link ng.$exceptionHandler $exceptionHandler} service.
        *
-       * @param {string} name Event name to emit.
+       * @param {string} name Event name to broadcast.
        * @param {...*} args Optional set of arguments which will be passed onto the event listeners.
        * @return {Object} Event object, see {@link ng.$rootScope.Scope#$on}
        */

Original file line number	Diff line number	Diff line change
`@@ -862,7 +862,7 @@ function $RootScopeProvider(){`
`862`	`862`	`* Any exception emitted from the {@link ng.$rootScope.Scope#$on listeners} will be passed`
`863`	`863`	`* onto the {@link ng.$exceptionHandler $exceptionHandler} service.`
`864`	`864`	`*`
`865`		`- * @param {string} name Event name to emit.`
	`865`	`+ * @param {string} name Event name to broadcast.`
`866`	`866`	`* @param {...*} args Optional set of arguments which will be passed onto the event listeners.`
`867`	`867`	`* @return {Object} Event object, see {@link ng.$rootScope.Scope#$on}`
`868`	`868`	`*/`