$locationChangeStart, $locationChangeSuccess events are not documented

[nickretallack]

These events are emitted by angular, but they are never mentioned in the documentation: $locationChangeStart, $locationChangeSuccess, $includeContentLoaded, $viewContentLoaded, $routeChangeStart, $routeChangeError

The other events are only mentioned in passing: $routeUpdate, $routeChangeSuccess. It would be nice if events had a place in the documentation.

[pkozlowski-opensource]

So, had a quick look at the docs and in fact most of the events are documented:

• $includeContentLoaded: http://docs.angularjs.org/api/ng.directive:ngInclude
• $viewContentLoaded: http://docs.angularjs.org/api/ng.directive:ngView
• $routeChangeStart, $routeChangeError: http://docs.angularjs.org/api/ng.$route

The only ones missing from the doc seem to be the $location events (or at least I can't find docs for them). Changing the title of this issue to better reflect this.

[gotoAndBliss]

Also the search does not pick up any of these keywords, neither can Google find them.

[boxed]

Am I right in understanding that the docs are generated from the comment marked with "@ngdoc" in https://github.com/angular/angular.js/blob/master/src/ng/http.js ?

[wladston]

+1, took me a long time to find that these actually existed.

[btford]

As part of our effort to clean out old issues, this issue is being automatically closed since it has been inactivite for over two months.

Please try the newest versions of Angular (1.0.8 and 1.2.0-rc.1), and if the issue persists, comment below so we can discuss it.

Thanks!

[nickretallack]

What? Don't just close this. Document it. These events are still undocumented in the latest version. http://code.angularjs.org/1.2.0rc1/docs/api/ng.$location

[btford]

Would anyone like to submit a PR for this? :)

[Nitrodist]

I'll probably get around to doing it. Is the ng.$location page the appropriate place to do it? Is there similar documentation that I can look at so that I know what kinds of things I should explain?

[pkozlowski-opensource]

@Nitrodist a PR would be awesome. Yes, $location is the proper place. While preparing a PR you can use documentation of the existing routing events as an example:
https://github.com/angular/angular.js/blob/master/src/ngRoute/route.js#L337-L390