From b09595a3c12ba761772084b94767b635c5bbfaf2 Mon Sep 17 00:00:00 2001 From: Misko Hevery Date: Thu, 10 Nov 2011 18:47:47 -0800 Subject: fix(doc) cleanup all api doc link warnings --- docs/content/api/angular.module.ngdoc | 2 +- docs/content/api/index.ngdoc | 16 +++---- docs/content/cookbook/deeplinking.ngdoc | 4 +- docs/content/cookbook/form.ngdoc | 2 +- docs/content/cookbook/helloworld.ngdoc | 2 +- docs/content/cookbook/index.ngdoc | 2 +- docs/content/cookbook/mvc.ngdoc | 2 +- .../guide/dev_guide.bootstrap.auto_bootstrap.ngdoc | 2 +- docs/content/guide/dev_guide.di.ngdoc | 2 +- .../guide/dev_guide.di.understanding_di.ngdoc | 12 ++--- .../guide/dev_guide.di.using_di_controllers.ngdoc | 2 +- docs/content/guide/dev_guide.e2e-testing.ngdoc | 8 ++-- docs/content/guide/dev_guide.expressions.ngdoc | 8 ++-- docs/content/guide/dev_guide.forms.ngdoc | 18 ++++---- docs/content/guide/dev_guide.i18n.ngdoc | 14 +++--- .../dev_guide.mvc.understanding_controller.ngdoc | 8 ++-- .../content/guide/dev_guide.scopes.internals.ngdoc | 52 +++++++++++----------- docs/content/guide/dev_guide.scopes.ngdoc | 10 ++--- .../dev_guide.scopes.understanding_scopes.ngdoc | 2 +- .../guide/dev_guide.services.$location.ngdoc | 20 ++++----- .../dev_guide.services.creating_services.ngdoc | 6 +-- .../dev_guide.services.injecting_controllers.ngdoc | 2 +- .../dev_guide.services.managing_dependencies.ngdoc | 12 ++--- docs/content/guide/dev_guide.services.ngdoc | 2 +- .../dev_guide.services.registering_services.ngdoc | 8 ++-- .../dev_guide.services.testing_services.ngdoc | 4 +- ...dev_guide.services.understanding_services.ngdoc | 4 +- ..._guide.templates.filters.creating_filters.ngdoc | 15 +++---- .../guide/dev_guide.templates.filters.ngdoc | 4 +- ...dev_guide.templates.filters.using_filters.ngdoc | 4 +- docs/content/guide/dev_guide.templates.ngdoc | 2 +- docs/content/guide/dev_guide.unit-testing.ngdoc | 6 +-- docs/content/misc/faq.ngdoc | 2 +- docs/content/tutorial/step_02.ngdoc | 2 +- docs/content/tutorial/step_03.ngdoc | 4 +- docs/content/tutorial/step_04.ngdoc | 4 +- docs/content/tutorial/step_05.ngdoc | 14 +++--- docs/content/tutorial/step_07.ngdoc | 4 +- docs/content/tutorial/step_08.ngdoc | 2 +- docs/content/tutorial/step_09.ngdoc | 10 ++--- docs/content/tutorial/step_11.ngdoc | 24 +++++----- docs/spec/ngdocSpec.js | 20 ++++----- docs/src/ngdoc.js | 18 +++++--- 43 files changed, 178 insertions(+), 183 deletions(-) (limited to 'docs') diff --git a/docs/content/api/angular.module.ngdoc b/docs/content/api/angular.module.ngdoc index 91cd311d..f35fc589 100644 --- a/docs/content/api/angular.module.ngdoc +++ b/docs/content/api/angular.module.ngdoc @@ -25,7 +25,7 @@ function MyModule($provide, $locationProvider){ }; -See: {@link angular.module.NG.$provide $provide}, {@link angular.module.NG.$locationProvider $locationProvider}. +See: {@link angular.module.AUTO.$provide $provide}, {@link angular.module.NG.$locationProvider $locationProvider}. # Registering Module Function diff --git a/docs/content/api/index.ngdoc b/docs/content/api/index.ngdoc index f48a2b38..6c5745dc 100644 --- a/docs/content/api/index.ngdoc +++ b/docs/content/api/index.ngdoc @@ -7,23 +7,23 @@ * {@link angular.widget Widgets} - Angular custom DOM element * {@link angular.directive Directives} - Angular DOM element attributes * {@link angular.markup Markup} and {@link angular.attrMarkup Attribute Markup} -* {@link angular.filter Filters} - Angular output filters -* {@link angular.compile angular.compile()} - Template compiler +* {@link angular.module.NG.$filter Filters} - Angular output filters +* {@link angular.module.NG.$compile $compile} - Template compiler ## Angular Scope API -* {@link angular.scope Scope Object} - Angular scope object +* {@link angular.module.NG.$rootScope.Scope Scope Object} - Angular scope object ## Angular Services & Dependency Injection API -* {@link angular.service Angular Services} +* {@link angular.module.NG Angular Services} * {@link angular.injector angular.injector() } ## Angular Testing API -* {@link angular.mock Testing Mocks API} - Mock objects for testing +* {@link angular.module.NG_MOCK Testing Mocks API} - Mock objects for testing * {@link guide/dev_guide.e2e-testing Angular Scenario Runner} - Automated scenario testing documentation @@ -63,9 +63,3 @@ documentation * {@link angular.fromJson angular.fromJson() } * {@link angular.toJson angular.toJson() } - - - -## Utility methods for JavaScript types -* {@link angular.Object Object API} - Utility functions for JavaScript objects -* {@link angular.Array Array API} - Utility functions for JavaScript arrays diff --git a/docs/content/cookbook/deeplinking.ngdoc b/docs/content/cookbook/deeplinking.ngdoc index 27087726..f1f1397a 100644 --- a/docs/content/cookbook/deeplinking.ngdoc +++ b/docs/content/cookbook/deeplinking.ngdoc @@ -105,9 +105,9 @@ The two partials are defined in the following URLs: # Things to notice * Routes are defined in the `AppCntl` class. The initialization of the controller causes the - initialization of the {@link api/angular.service.$route $route} service with the proper URL + initialization of the {@link api/angular.module.NG.$route $route} service with the proper URL routes. -* The {@link api/angular.service.$route $route} service then watches the URL and instantiates the +* The {@link api/angular.module.NG.$route $route} service then watches the URL and instantiates the appropriate controller when the URL changes. * The {@link api/angular.widget.ng:view ng:view} widget loads the view when the URL changes. It also diff --git a/docs/content/cookbook/form.ngdoc b/docs/content/cookbook/form.ngdoc index 1b5bf32b..9136e0f4 100644 --- a/docs/content/cookbook/form.ngdoc +++ b/docs/content/cookbook/form.ngdoc @@ -104,7 +104,7 @@ allow a user to enter data. * The user data model is initialized {@link api/angular.directive.ng:controller controller} and is available in - the {@link api/angular.scope scope} with the initial data. + the {@link api/angular.module.NG.$rootScope.Scope scope} with the initial data. * For debugging purposes we have included a debug view of the model to better understand what is going on. * The {@link api/angular.widget.input input widgets} simply refer to the model and are data-bound. diff --git a/docs/content/cookbook/helloworld.ngdoc b/docs/content/cookbook/helloworld.ngdoc index c93cdbea..e52f68e3 100644 --- a/docs/content/cookbook/helloworld.ngdoc +++ b/docs/content/cookbook/helloworld.ngdoc @@ -31,7 +31,7 @@ Take a look through the source and note: * The script tag that {@link guide/dev_guide.bootstrap bootstraps} the angular environment. * The text {@link api/angular.widget.input input widget} which is bound to the greeting name text. * No need for listener registration and event firing on change events. -* The implicit presence of the `name` variable which is in the root {@link api/angular.scope scope}. +* The implicit presence of the `name` variable which is in the root {@link api/angular.module.NG.$rootScope.Scope scope}. * The double curly brace `{{markup}}`, which binds the name variable to the greeting text. * The concept of {@link guide/dev_guide.templates.databinding data binding}, which reflects any changes to the diff --git a/docs/content/cookbook/index.ngdoc b/docs/content/cookbook/index.ngdoc index 06b898ac..aca42369 100644 --- a/docs/content/cookbook/index.ngdoc +++ b/docs/content/cookbook/index.ngdoc @@ -44,7 +44,7 @@ allowing you to send links to specific screens in your app. # Services -{@link api/angular.service Services}: Services are long lived objects in your applications that are +{@link api/angular.module.NG Services}: Services are long lived objects in your applications that are available across controllers. A collection of useful services are pre-bundled with angular but you will likely add your own. Services are initialized using dependency injection, which resolves the order of initialization. This safeguards you from the perils of global state (a common way to diff --git a/docs/content/cookbook/mvc.ngdoc b/docs/content/cookbook/mvc.ngdoc index 28b8836f..3de9eb25 100644 --- a/docs/content/cookbook/mvc.ngdoc +++ b/docs/content/cookbook/mvc.ngdoc @@ -121,4 +121,4 @@ board variable. * The view can call any controller function. * In this example, the `setUrl()` and `readUrl()` functions copy the game state to/from the URL's hash so the browser's back button will undo game steps. See deep-linking. This example calls {@link -api/angular.scope.$watch $watch()} to set up a listener that invokes `readUrl()` when needed. +api/angular.module.NG.$rootScope.Scope#$watch $watch()} to set up a listener that invokes `readUrl()` when needed. diff --git a/docs/content/guide/dev_guide.bootstrap.auto_bootstrap.ngdoc b/docs/content/guide/dev_guide.bootstrap.auto_bootstrap.ngdoc index 438b3d38..a75dc52f 100644 --- a/docs/content/guide/dev_guide.bootstrap.auto_bootstrap.ngdoc +++ b/docs/content/guide/dev_guide.bootstrap.auto_bootstrap.ngdoc @@ -98,4 +98,4 @@ APIs are bound to fields of this global object. ## Related API -{@link api/angular.compile Compiler API} +{@link api/angular.module.NG.$compile Compiler API} diff --git a/docs/content/guide/dev_guide.di.ngdoc b/docs/content/guide/dev_guide.di.ngdoc index fc303e58..f9ff49c4 100644 --- a/docs/content/guide/dev_guide.di.ngdoc +++ b/docs/content/guide/dev_guide.di.ngdoc @@ -28,5 +28,5 @@ book. ## Related API -* {@link api/angular.service Service API} +* {@link api/angular.module.NG Service API} * {@link api/angular.injector Angular Injector API} diff --git a/docs/content/guide/dev_guide.di.understanding_di.ngdoc b/docs/content/guide/dev_guide.di.understanding_di.ngdoc index 202fa3c6..1dc9bd85 100644 --- a/docs/content/guide/dev_guide.di.understanding_di.ngdoc +++ b/docs/content/guide/dev_guide.di.understanding_di.ngdoc @@ -7,15 +7,15 @@ While DI is widely used in statically typed languages such as Java or C++, it ha used in JavaScript. Angular brings the benefits of DI into JavaScript apps. In angular, DI is implemented as a subsystem that manages dependencies between services, -controllers, widgets, and filters. The most important of these are {@link api/angular.service +controllers, widgets, and filters. The most important of these are {@link api/angular.module.NG services}. Services are objects that handle common tasks in web applications. Angular provides several{@link -api/angular.service built-in services}, and you can create your own custom services. +api/angular.module.NG built-in services}, and you can create your own custom services. The main job of angular's DI subsystem is to provide services to angular components that depend on them. The way the DI subsystem provides services is as follows: all services are registered with -angular's {@link api/angular.service service API}, and all components that depend on services +angular's {@link api/angular.module.NG service API}, and all components that depend on services define those dependencies as a property (`$inject`). With this information, the DI subsystem manages the creation of service objects and the provision of those objects to the components that 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
// create a root scope
-var rootScope = angular.scope();
+var rootScope = angular.module.NG.$rootScope.Scope();
// access the service locator
var myService = rootScope.$service('myService');
@@ -74,7 +74,7 @@ equivalent:
// given a user defined service
-angular.service('serviceA', ...);
+angular.module.NG('serviceA', ...);
// inject '$window', 'serviceA', curry 'name';
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
## Related API
-* {@link api/angular.service Services API}
+* {@link api/angular.module.NG Services API}
diff --git a/docs/content/guide/dev_guide.di.using_di_controllers.ngdoc b/docs/content/guide/dev_guide.di.using_di_controllers.ngdoc
index 035d1663..3d087d18 100644
--- a/docs/content/guide/dev_guide.di.using_di_controllers.ngdoc
+++ b/docs/content/guide/dev_guide.di.using_di_controllers.ngdoc
@@ -14,7 +14,7 @@ MyController.$inject = ['$route'];
In this example, the `MyController` constructor function takes one argument, the {@link
-api/angular.service.$route $route} service. Angular is then responsible for supplying the instance
+api/angular.module.NG.$route $route} service. Angular is then responsible for supplying the instance
of `$route` to the controller when the constructor is instantiated. There are two ways to cause
controller instantiation – by configuring routes with the `$route` service, or by referencing the
controller from the HTML template, as follows:
diff --git a/docs/content/guide/dev_guide.e2e-testing.ngdoc b/docs/content/guide/dev_guide.e2e-testing.ngdoc
index d725e07a..6dbb9c1e 100644
--- a/docs/content/guide/dev_guide.e2e-testing.ngdoc
+++ b/docs/content/guide/dev_guide.e2e-testing.ngdoc
@@ -78,19 +78,19 @@ Returns the window.location.search of the currently loaded page in the test fram
Returns the window.location.hash (without `#`) of the currently loaded page in the test frame.
## browser().location().url()
-Returns the {@link api/angular.service.$location $location.url()} of the currently loaded page in
+Returns the {@link api/angular.module.NG.$location $location.url()} of the currently loaded page in
the test frame.
## browser().location().path()
-Returns the {@link api/angular.service.$location $location.path()} of the currently loaded page in
+Returns the {@link api/angular.module.NG.$location $location.path()} of the currently loaded page in
the test frame.
## browser().location().search()
-Returns the {@link api/angular.service.$location $location.search()} of the currently loaded page
+Returns the {@link api/angular.module.NG.$location $location.search()} of the currently loaded page
in the test frame.
## browser().location().hash()
-Returns the {@link api/angular.service.$location $location.hash()} of the currently loaded page in
+Returns the {@link api/angular.module.NG.$location $location.hash()} of the currently loaded page in
the test frame.
## expect(future).{matcher}
diff --git a/docs/content/guide/dev_guide.expressions.ngdoc b/docs/content/guide/dev_guide.expressions.ngdoc
index b9417b38..4867f9d0 100644
--- a/docs/content/guide/dev_guide.expressions.ngdoc
+++ b/docs/content/guide/dev_guide.expressions.ngdoc
@@ -165,15 +165,15 @@ JavaScript method instead.
Built-in types have methods like `[].push()`, but the richness of these methods is limited.
Consider the example below, which allows you to do a simple search over a canned set of contacts.
The example would be much more complicated if we did not have the `Array:$filter()`. There is no
-built-in method on `Array` called {@link api/angular.Array.filter $filter} and angular doesn't add
+built-in method on `Array` called {@link api/angular.module.NG.$filter.filter $filter} and angular doesn't add
it to `Array.prototype` because that could collide with other JavaScript frameworks.
For this reason the scope expression evaluator augments the built-in types to make them act like
-they have extra methods. The actual method for `$filter()` is `angular.Array.filter()`. You can
+they have extra methods. The actual method for `$filter()` is `angular.module.NG.$filter.filter()`. You can
call it from JavaScript.
Extensions: You can further extend the expression vocabulary by adding new methods to
-`angular.Array` or `angular.String`, etc.
+`angular.module.NG.$filter` or `angular.String`, etc.