Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 3f98d6a

Browse files
committed
docs(*): more docs
1 parent 22309c3 commit 3f98d6a

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

CHANGELOG.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@
66

77
## Features:
88

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

src/loader.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ function setupModuleLoader(window) {
2323
* @name angular.module
2424
* @description
2525
*
26-
* The `angular.module` is a global place for registering angular modules. All modules
27-
* (angular core or 3rd party) that should be available to an application must be registered
28-
* using this mechanism.
26+
* The `angular.module` is a global place for creating and registering Angular modules. All
27+
* modules (angular core or 3rd party) that should be available to an application must be
28+
* registered using this mechanism.
2929
*
3030
*
3131
* # Module
@@ -61,7 +61,7 @@ function setupModuleLoader(window) {
6161
* the module is being retrieved for further configuration.
6262
* @param {Function} configFn Option configuration function for the module. Same as
6363
* {@link angular.Module#config Module#config()}.
64-
* @return {angular.Module}
64+
* @returns {module} new module with the {@link angular.Module} api.
6565
*/
6666
return function module(name, requires, configFn) {
6767
if (requires && modules.hasOwnProperty(name)) {

0 commit comments

Comments
 (0)