$routeChangeSuccess documentation

I hope this helps someone, I ran into some issues when following the API as described - handlers of this event receive 3 arguments, not 2.

Although this is mentioned [elsewhere](http://docs.angularjs.org/api/ng.$rootScope.Scope#$on) it's not clear when viewing the docs for this behaviour in isolation. 

The first argument is an Event Object, not the current route. The previous route argument can also be omitted on occasions.
This commit is contained in:
Jamie Mason 2013-03-15 09:24:52 +00:00 committed by Misko Hevery
parent 70cf0a389f
commit 866d3fb573

View file

@ -263,8 +263,9 @@ function $RouteProvider(){
* {@link ng.directive:ngView ngView} listens for the directive
* to instantiate the controller and render the view.
*
* @param {Object} angularEvent Synthetic event object.
* @param {Route} current Current route information.
* @param {Route} previous Previous route information.
* @param {Route|Undefined} previous Previous route information, or undefined if current is first route entered.
*/
/**