Skip to content

Commit b09595a

Browse files
mheverymhevery
committed
fix(doc) cleanup all api doc link warnings
1 parent f6d98f1 commit b09595a

61 files changed

Lines changed: 270 additions & 253 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/content/api/angular.module.ngdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ function MyModule($provide, $locationProvider){
2525
};
2626
</pre>
2727

28-
See: {@link angular.module.NG.$provide $provide}, {@link angular.module.NG.$locationProvider $locationProvider}.
28+
See: {@link angular.module.AUTO.$provide $provide}, {@link angular.module.NG.$locationProvider $locationProvider}.
2929

3030
# Registering Module Function
3131

‎docs/content/api/index.ngdoc‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@
77
* {@link angular.widget Widgets} - Angular custom DOM element
88
* {@link angular.directive Directives} - Angular DOM element attributes
99
* {@link angular.markup Markup} and {@link angular.attrMarkup Attribute Markup}
10-
* {@link angular.filter Filters} - Angular output filters
11-
* {@link angular.compile angular.compile()} - Template compiler
10+
* {@link angular.module.NG.$filter Filters} - Angular output filters
11+
* {@link angular.module.NG.$compile $compile} - Template compiler
1212

1313
## Angular Scope API
1414

15-
* {@link angular.scope Scope Object} - Angular scope object
15+
* {@link angular.module.NG.$rootScope.Scope Scope Object} - Angular scope object
1616

1717

1818
## Angular Services & Dependency Injection API
1919

20-
* {@link angular.service Angular Services}
20+
* {@link angular.module.NG Angular Services}
2121
* {@link angular.injector angular.injector() }
2222

2323

2424
## Angular Testing API
2525

26-
* {@link angular.mock Testing Mocks API} - Mock objects for testing
26+
* {@link angular.module.NG_MOCK Testing Mocks API} - Mock objects for testing
2727
* {@link guide/dev_guide.e2e-testing Angular Scenario Runner} - Automated scenario testing
2828
documentation
2929

@@ -63,9 +63,3 @@ documentation
6363

6464
* {@link angular.fromJson angular.fromJson() }
6565
* {@link angular.toJson angular.toJson() }
66-
67-
68-
69-
## Utility methods for JavaScript types
70-
* {@link angular.Object Object API} - Utility functions for JavaScript objects
71-
* {@link angular.Array Array API} - Utility functions for JavaScript arrays

‎docs/content/cookbook/deeplinking.ngdoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ The two partials are defined in the following URLs:
105105
# Things to notice
106106

107107
* Routes are defined in the `AppCntl` class. The initialization of the controller causes the
108-
initialization of the {@link api/angular.service.$route $route} service with the proper URL
108+
initialization of the {@link api/angular.module.NG.$route $route} service with the proper URL
109109
routes.
110-
* The {@link api/angular.service.$route $route} service then watches the URL and instantiates the
110+
* The {@link api/angular.module.NG.$route $route} service then watches the URL and instantiates the
111111
appropriate controller when the URL changes.
112112
* The {@link api/angular.widget.ng:view ng:view} widget loads the view when the URL changes. It
113113
also

‎docs/content/cookbook/form.ngdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ allow a user to enter data.
104104

105105
* The user data model is initialized {@link api/angular.directive.ng:controller controller} and is
106106
available in
107-
the {@link api/angular.scope scope} with the initial data.
107+
the {@link api/angular.module.NG.$rootScope.Scope scope} with the initial data.
108108
* For debugging purposes we have included a debug view of the model to better understand what
109109
is going on.
110110
* The {@link api/angular.widget.input input widgets} simply refer to the model and are data-bound.

‎docs/content/cookbook/helloworld.ngdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Take a look through the source and note:
3131
* The script tag that {@link guide/dev_guide.bootstrap bootstraps} the angular environment.
3232
* The text {@link api/angular.widget.input input widget} which is bound to the greeting name text.
3333
* No need for listener registration and event firing on change events.
34-
* The implicit presence of the `name` variable which is in the root {@link api/angular.scope scope}.
34+
* The implicit presence of the `name` variable which is in the root {@link api/angular.module.NG.$rootScope.Scope scope}.
3535
* The double curly brace `{{markup}}`, which binds the name variable to the greeting text.
3636
* The concept of {@link guide/dev_guide.templates.databinding data binding}, which reflects any
3737
changes to the

‎docs/content/cookbook/index.ngdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ allowing you to send links to specific screens in your app.
4444

4545
# Services
4646

47-
{@link api/angular.service Services}: Services are long lived objects in your applications that are
47+
{@link api/angular.module.NG Services}: Services are long lived objects in your applications that are
4848
available across controllers. A collection of useful services are pre-bundled with angular but you
4949
will likely add your own. Services are initialized using dependency injection, which resolves the
5050
order of initialization. This safeguards you from the perils of global state (a common way to

‎docs/content/cookbook/mvc.ngdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,4 +121,4 @@ board variable.
121121
* The view can call any controller function.
122122
* In this example, the `setUrl()` and `readUrl()` functions copy the game state to/from the URL's
123123
hash so the browser's back button will undo game steps. See deep-linking. This example calls {@link
124-
api/angular.scope.$watch $watch()} to set up a listener that invokes `readUrl()` when needed.
124+
api/angular.module.NG.$rootScope.Scope#$watch $watch()} to set up a listener that invokes `readUrl()` when needed.

‎docs/content/guide/dev_guide.bootstrap.auto_bootstrap.ngdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ APIs are bound to fields of this global object.
9898

9999
## Related API
100100

101-
{@link api/angular.compile Compiler API}
101+
{@link api/angular.module.NG.$compile Compiler API}

‎docs/content/guide/dev_guide.di.ngdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ book.
2828

2929
## Related API
3030

31-
* {@link api/angular.service Service API}
31+
* {@link api/angular.module.NG Service API}
3232
* {@link api/angular.injector Angular Injector API}

‎docs/content/guide/dev_guide.di.understanding_di.ngdoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ While DI is widely used in statically typed languages such as Java or C++, it ha
77
used in JavaScript. Angular brings the benefits of DI into JavaScript apps.
88

99
In angular, DI is implemented as a subsystem that manages dependencies between services,
10-
controllers, widgets, and filters. The most important of these are {@link api/angular.service
10+
controllers, widgets, and filters. The most important of these are {@link api/angular.module.NG
1111
services}.
1212

1313
Services are objects that handle common tasks in web applications. Angular provides several{@link
14-
api/angular.service built-in services}, and you can create your own custom services.
14+
api/angular.module.NG built-in services}, and you can create your own custom services.
1515

1616
The main job of angular's DI subsystem is to provide services to angular components that depend on
1717
them. The way the DI subsystem provides services is as follows: all services are registered with
18-
angular's {@link api/angular.service service API}, and all components that depend on services
18+
angular's {@link api/angular.module.NG service API}, and all components that depend on services
1919
define those dependencies as a property (`$inject`). With this information, the DI subsystem
2020
manages the creation of service objects and the provision of those objects to the components that
2121
need them, at the time they need them. The following illustration steps through the sequence of
@@ -49,7 +49,7 @@ achieve the necessary isolation by having each test create its own separate root
4949

5050
<pre>
5151
// create a root scope
52-
var rootScope = angular.scope();
52+
var rootScope = angular.module.NG.$rootScope.Scope();
5353
// access the service locator
5454
var myService = rootScope.$service('myService');
5555
</pre>
@@ -74,7 +74,7 @@ equivalent:
7474

7575
<pre>
7676
// given a user defined service
77-
angular.service('serviceA', ...);
77+
angular.module.NG('serviceA', ...);
7878

7979
// inject '$window', 'serviceA', curry 'name';
8080
function fnA($window, serviceA, name){};
@@ -102,4 +102,4 @@ code and insert the `$inject` into the source code so that it can be minified/ob
102102

103103
## Related API
104104

105-
* {@link api/angular.service Services API}
105+
* {@link api/angular.module.NG Services API}

0 commit comments

Comments
 (0)