docs(*): more docs

This commit is contained in:
Igor Minar 2012-01-17 12:13:48 -08:00
parent 22309c312f
commit 3f98d6ac99
2 changed files with 15 additions and 10 deletions

View file

@ -6,21 +6,21 @@
## Features: ## Features:
- [Dependency injection subsystem][$injector] rewrite. This is a huge change to the Angular core - [Dependency injection subsystem][guide2.di] rewrite. This is a huge change to the Angular core
that was necessary for many reasons. Please read the full that was necessary for many reasons. Please read the full
[design doc](https://docs.google.com/document/d/1hJnIqWhSt7wCacmWBB01Bmc6faZ8XdXJAEeiJwjZmqs/edit?hl=en_US) [design doc](https://docs.google.com/document/d/1hJnIqWhSt7wCacmWBB01Bmc6faZ8XdXJAEeiJwjZmqs/edit?hl=en_US)
to understand the changes and reasoning behind them. to understand the changes and reasoning behind them.
- Added [angular.bootstrap] for manual bootstrapping of the app. Also see - Added [angular.bootstrap] for manual bootstrapping of the app. Also see
[Initializing Angular App][bootstraping] doc. [Initializing Angular App][bootstrapping] doc.
- Helper functions [inject] and [module] that make testing with DI and jasmine a lot easier. - Helper functions [inject] and [module] that make testing with DI and jasmine a lot easier.
- [jqLite] and jQuery were extended with helper method `injector()` that simplifies the access to - [jqLite][jqLite2] and jQuery were extended with helper method `injector()` that simplifies the
the application injector during debugging. access to the application injector during debugging.
- Rewrite of $xhr service and its dependencies, which was replaced with [$http] service. - Rewrite of $xhr service and its dependencies, which was replaced with [$http] service.
The $browser.xhr and its mock were replaced by [$httpBackend] and its The $browser.xhr and its mock were replaced by [$httpBackend] and its
[unit testing][unit-testing $httpBackend] and [end-to-end testing][e2e-testing $httpBackend] [unit testing][unit-testing $httpBackend] and [end-to-end testing][e2e-testing $httpBackend]
mocks. The $resource service api and functionality was preserved, with the exception of caching, mocks. The $resource service api and functionality was preserved, with the exception of caching,
which is not happening automatically as it used it in the past (verifyCache has no effect). which is not happening automatically as it used it in the past (verifyCache has no effect).
- [$q] - Q-like deferred/promise implementation - [$q] - Q-like deferred/promise implementation
([commit](https://github.com/angular/angular.js/commit/1cdfa3b9601c199ec0b45096b38e26350eca744f)) ([commit](https://github.com/angular/angular.js/commit/1cdfa3b9601c199ec0b45096b38e26350eca744f))
- Transparent data-binding to promises in templates. [Example](http://jsfiddle.net/IgorMinar/aNSWu/) - Transparent data-binding to promises in templates. [Example](http://jsfiddle.net/IgorMinar/aNSWu/)
([commit](https://github.com/angular/angular.js/commit/78b6e8a446c0e38075c14b724f3cdf345c01fa06)) ([commit](https://github.com/angular/angular.js/commit/78b6e8a446c0e38075c14b724f3cdf345c01fa06))
@ -52,6 +52,8 @@
- scope.$service is no more (because injector creates scope and not the other way around), - scope.$service is no more (because injector creates scope and not the other way around),
if you really can't get services injected and need to fetch them manually then, get hold of if you really can't get services injected and need to fetch them manually then, get hold of
[$injector] service and call $injector.get('serviceId') [$injector] service and call $injector.get('serviceId')
- angular.service style service registration was replaced with module system, please see
[angular.module] api and [DI documentation][guide2.di] for more info.
- the $xhr service was replaced with [$http] with promise based apis. - the $xhr service was replaced with [$http] with promise based apis.
- [unit-testing $httpBackend]'s expect method (the replacement for $browser.xhr.expect) is stricter - - [unit-testing $httpBackend]'s expect method (the replacement for $browser.xhr.expect) is stricter -
the order of requests matters and a single request expectation can handle only a single request. the order of requests matters and a single request expectation can handle only a single request.
@ -1070,15 +1072,18 @@ with the `$route` service
[angular.bootstrap]: http://docs-next.angularjs.org/api/angular.bootstrap [angular.bootstrap]: http://docs-next.angularjs.org/api/angular.bootstrap
[$anchorScroll]: http://docs-next.angularjs.org/api/angular.module.ng.$anchorScroll [$anchorScroll]: http://docs-next.angularjs.org/api/angular.module.ng.$anchorScroll
[$cacheFactory]: http://docs-next.angularjs.org/api/angular.module.ng.$cacheFactory [$cacheFactory]: http://docs-next.angularjs.org/api/angular.module.ng.$cacheFactory
[bootstraping]: http://docs-next.angularjs.org/guide/dev_guide.bootstrap [bootstrapping]: http://docs-next.angularjs.org/guide/dev_guide.bootstrap
[angular.copy]: http://docs-next.angularjs.org/api/angular.copy [angular.copy]: http://docs-next.angularjs.org/api/angular.copy
[ng:app]: http://docs-next.angularjs.org/api/angular.directive.ng:app [ng:app]: http://docs-next.angularjs.org/api/angular.directive.ng:app
[$compile]: http://docs-next.angularjs.org/api/angular.module.ng.$compile [$compile]: http://docs-next.angularjs.org/api/angular.module.ng.$compile
[$filterProvider]: http://docs-next.angularjs.org/api/angular.module.ng.$filterProvider [$filterProvider]: http://docs-next.angularjs.org/api/angular.module.ng.$filterProvider
[angular.Module]: http://docs-next.angularjs.org/api/angular.Module [angular.Module]: http://docs-next.angularjs.org/api/angular.Module
[angular.module]: http://docs-next.angularjs.org/api/angular.module
[filter]: http://docs-next.angularjs.org/api/angular.module.ng.$filter.filter [filter]: http://docs-next.angularjs.org/api/angular.module.ng.$filter.filter
[limitTo]: http://docs-next.angularjs.org/api/angular.module.ng.$filter.limitTo [limitTo]: http://docs-next.angularjs.org/api/angular.module.ng.$filter.limitTo
[orderBy]: http://docs-next.angularjs.org/api/angular.module.ng.$filter.orderBy [orderBy]: http://docs-next.angularjs.org/api/angular.module.ng.$filter.orderBy
[$browser.defer.flush]: http://docs-next.angularjs.org/api/angular.module.ngMock.$browser#defer.flush [$browser.defer.flush]: http://docs-next.angularjs.org/api/angular.module.ngMock.$browser#defer.flush
[inject]: http://docs-next.angularjs.org/api/angular.mock.inject [inject]: http://docs-next.angularjs.org/api/angular.mock.inject
[module]: http://docs-next.angularjs.org/api/angular.mock.module [module]: http://docs-next.angularjs.org/api/angular.mock.module
[guide2.di]: http://docs-next.angularjs.org/guide/dev_guide.di
[jqLite2]: http://docs.angularjs.org/#!/api/angular.element

View file

@ -23,9 +23,9 @@ function setupModuleLoader(window) {
* @name angular.module * @name angular.module
* @description * @description
* *
* The `angular.module` is a global place for registering angular modules. All modules * The `angular.module` is a global place for creating and registering Angular modules. All
* (angular core or 3rd party) that should be available to an application must be registered * modules (angular core or 3rd party) that should be available to an application must be
* using this mechanism. * registered using this mechanism.
* *
* *
* # Module * # Module
@ -61,7 +61,7 @@ function setupModuleLoader(window) {
* the module is being retrieved for further configuration. * the module is being retrieved for further configuration.
* @param {Function} configFn Option configuration function for the module. Same as * @param {Function} configFn Option configuration function for the module. Same as
* {@link angular.Module#config Module#config()}. * {@link angular.Module#config Module#config()}.
* @return {angular.Module} * @returns {module} new module with the {@link angular.Module} api.
*/ */
return function module(name, requires, configFn) { return function module(name, requires, configFn) {
if (requires && modules.hasOwnProperty(name)) { if (requires && modules.hasOwnProperty(name)) {