From a564160511bf1bbed5a4fe5d2981fae1bb664eca Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Wed, 12 Feb 2014 22:47:42 +0000 Subject: docs(bike-shed-migration): fix url-based links refs to AUTO module --- docs/content/error/cacheFactory/iid.ngdoc | 2 +- docs/content/error/compile/ctreq.ngdoc | 6 +-- docs/content/error/compile/iscp.ngdoc | 2 +- docs/content/error/compile/nonassign.ngdoc | 2 +- docs/content/error/compile/selmulti.ngdoc | 4 +- docs/content/error/compile/tpload.ngdoc | 4 +- docs/content/error/controller/noscp.ngdoc | 4 +- docs/content/error/injector/cdep.ngdoc | 2 +- docs/content/error/injector/modulerr.ngdoc | 2 +- docs/content/error/injector/nomod.ngdoc | 2 +- docs/content/error/injector/pget.ngdoc | 2 +- docs/content/error/interpolate/noconcat.ngdoc | 2 +- docs/content/error/jqLite/nosel.ngdoc | 2 +- docs/content/error/location/ihshprfx.ngdoc | 2 +- docs/content/error/location/ipthprfx.ngdoc | 2 +- docs/content/error/location/isrcharg.ngdoc | 2 +- docs/content/error/ngModel/nonassign.ngdoc | 4 +- docs/content/error/ngOptions/iexp.ngdoc | 2 +- docs/content/error/ngPattern/noregexp.ngdoc | 2 +- docs/content/error/ngRepeat/dupes.ngdoc | 2 +- docs/content/error/ngRepeat/iexp.ngdoc | 4 +- docs/content/error/ngRepeat/iidexp.ngdoc | 4 +- docs/content/error/resource/badargs.ngdoc | 4 +- docs/content/error/resource/badcfg.ngdoc | 4 +- docs/content/error/rootScope/infdig.ngdoc | 2 +- docs/content/error/rootScope/inprog.ngdoc | 2 +- docs/content/error/sce/icontext.ngdoc | 4 +- docs/content/error/sce/iequirks.ngdoc | 2 +- docs/content/error/sce/imatcher.ngdoc | 2 +- docs/content/error/sce/insecurl.ngdoc | 6 +-- docs/content/error/sce/itype.ngdoc | 4 +- docs/content/error/sce/iwcard.ngdoc | 2 +- docs/content/error/sce/unsafe.ngdoc | 2 +- docs/content/guide/animations.ngdoc | 22 ++++---- docs/content/guide/bootstrap.ngdoc | 14 ++--- docs/content/guide/compiler.ngdoc | 28 +++++----- docs/content/guide/concepts.ngdoc | 16 +++--- docs/content/guide/controller.ngdoc | 12 ++--- docs/content/guide/dev_guide.e2e-testing.ngdoc | 8 +-- .../guide/dev_guide.services.$location.ngdoc | 12 ++--- .../dev_guide.services.creating_services.ngdoc | 10 ++-- .../dev_guide.services.injecting_controllers.ngdoc | 2 +- .../dev_guide.services.managing_dependencies.ngdoc | 10 ++-- docs/content/guide/dev_guide.services.ngdoc | 2 +- .../dev_guide.services.testing_services.ngdoc | 2 +- ...dev_guide.services.understanding_services.ngdoc | 14 ++--- .../guide/dev_guide.templates.css-styling.ngdoc | 10 ++-- docs/content/guide/dev_guide.unit-testing.ngdoc | 2 +- docs/content/guide/directive.ngdoc | 26 ++++----- docs/content/guide/expression.ngdoc | 6 +-- docs/content/guide/filter.ngdoc | 10 ++-- docs/content/guide/forms.ngdoc | 24 ++++----- docs/content/guide/i18n.ngdoc | 2 +- docs/content/guide/index.ngdoc | 12 ++--- docs/content/guide/migration.ngdoc | 2 +- docs/content/guide/module.ngdoc | 2 +- docs/content/guide/providers.ngdoc | 4 +- docs/content/guide/scope.ngdoc | 62 +++++++++++----------- docs/content/guide/templates.ngdoc | 8 +-- docs/content/misc/faq.ngdoc | 4 +- docs/content/misc/started.ngdoc | 2 +- docs/content/tutorial/step_00.ngdoc | 6 +-- docs/content/tutorial/step_02.ngdoc | 6 +-- docs/content/tutorial/step_03.ngdoc | 10 ++-- docs/content/tutorial/step_04.ngdoc | 2 +- docs/content/tutorial/step_05.ngdoc | 12 ++--- docs/content/tutorial/step_07.ngdoc | 12 ++--- docs/content/tutorial/step_08.ngdoc | 2 +- docs/content/tutorial/step_09.ngdoc | 4 +- docs/content/tutorial/step_10.ngdoc | 2 +- docs/content/tutorial/step_11.ngdoc | 8 +-- 71 files changed, 243 insertions(+), 243 deletions(-) (limited to 'docs/content') diff --git a/docs/content/error/cacheFactory/iid.ngdoc b/docs/content/error/cacheFactory/iid.ngdoc index 838ff75e..62e985e8 100644 --- a/docs/content/error/cacheFactory/iid.ngdoc +++ b/docs/content/error/cacheFactory/iid.ngdoc @@ -3,6 +3,6 @@ @fullName Invalid ID @description -This error occurs when trying to create a new `cache` object via {@link api/ng.$cacheFactory} with an ID that was already used to create another cache object. +This error occurs when trying to create a new `cache` object via {@link ng.$cacheFactory} with an ID that was already used to create another cache object. To resolve the error please use a different cache ID when calling `$cacheFactory`. diff --git a/docs/content/error/compile/ctreq.ngdoc b/docs/content/error/compile/ctreq.ngdoc index e3f46532..47c876a3 100644 --- a/docs/content/error/compile/ctreq.ngdoc +++ b/docs/content/error/compile/ctreq.ngdoc @@ -3,7 +3,7 @@ @fullName Missing Required Controller @description -This error occurs when {@link api/ng.$compile HTML compiler} tries to process a directive that specifies the {@link api/ng.$compile#description_comprehensive-directive-api_directive-definition-object `require` option} in a {@link api/ng.$compile#description_comprehensive-directive-api directive definition}, +This error occurs when {@link ng.$compile HTML compiler} tries to process a directive that specifies the {@link ng.$compile#description_comprehensive-directive-api_directive-definition-object `require` option} in a {@link ng.$compile#description_comprehensive-directive-api directive definition}, but the required directive controller is not present on the current DOM element (or its ancestor element, if `^` was specified). To resolve this error ensure that there is no typo in the required controller name and that the required directive controller is present on the current element. @@ -13,7 +13,7 @@ If the required controller is expected to be on a ancestor element, make ensure If the required controller is optionally requested, use `?` or `^?` to specify that. -Example of a directive that requires {@link api/ng.directive:ngModel ngModel} controller: +Example of a directive that requires {@link ng.directive:ngModel ngModel} controller: ``` myApp.directive('myDirective', function() { return { @@ -29,7 +29,7 @@ This directive can then be used as: ``` -Example of a directive that optionally requires a {@link api/ng.directive:form form} controller from an ancestor: +Example of a directive that optionally requires a {@link ng.directive:form form} controller from an ancestor: ``` myApp.directive('myDirective', function() { return { diff --git a/docs/content/error/compile/iscp.ngdoc b/docs/content/error/compile/iscp.ngdoc index 0bfe216b..1450dec9 100644 --- a/docs/content/error/compile/iscp.ngdoc +++ b/docs/content/error/compile/iscp.ngdoc @@ -21,5 +21,5 @@ myModule.directive('directiveName', function factory() { }); ``` -Please refer to the {@link api/ng.$compile#description_comprehensive-directive-api_directive-definition-object +Please refer to the {@link ng.$compile#description_comprehensive-directive-api_directive-definition-object `scope` option} of the directive definition documentation to learn more about the API. diff --git a/docs/content/error/compile/nonassign.ngdoc b/docs/content/error/compile/nonassign.ngdoc index 3870c2ed..3a7d996b 100644 --- a/docs/content/error/compile/nonassign.ngdoc +++ b/docs/content/error/compile/nonassign.ngdoc @@ -4,7 +4,7 @@ @description This error occurs when a directive defines an isolate scope property -(using the `=` mode in the {@link api/ng.$compile#description_comprehensive-directive-api_directive-definition-object +(using the `=` mode in the {@link ng.$compile#description_comprehensive-directive-api_directive-definition-object `scope` option} of a directive definition) but the directive is used with an expression that is not-assignable. In order for the two-way data-binding to work, it must be possible to write new values back into the path defined with the expression. diff --git a/docs/content/error/compile/selmulti.ngdoc b/docs/content/error/compile/selmulti.ngdoc index 8154cc67..51221ad8 100644 --- a/docs/content/error/compile/selmulti.ngdoc +++ b/docs/content/error/compile/selmulti.ngdoc @@ -3,9 +3,9 @@ @fullName Binding to Multiple Attribute @description -Binding to the `multiple` attribute of `select` element is not supported since switching between multiple and single mode changes the {@link api/ng.directive:ngModel `ngModel`} object type from instance to array of instances which breaks the model semantics. +Binding to the `multiple` attribute of `select` element is not supported since switching between multiple and single mode changes the {@link ng.directive:ngModel `ngModel`} object type from instance to array of instances which breaks the model semantics. -If you need to use different types of `select` elements in your template based on some variable, please use {@link api/ng.directive:ngIf ngIf} or {@link api/ng.directive:ngSwitch ngSwitch} directives to select one of them to be used at runtime. +If you need to use different types of `select` elements in your template based on some variable, please use {@link ng.directive:ngIf ngIf} or {@link ng.directive:ngSwitch ngSwitch} directives to select one of them to be used at runtime. Example with invalid usage: diff --git a/docs/content/error/compile/tpload.ngdoc b/docs/content/error/compile/tpload.ngdoc index 3e0da4ab..b2b4fb2d 100644 --- a/docs/content/error/compile/tpload.ngdoc +++ b/docs/content/error/compile/tpload.ngdoc @@ -3,9 +3,9 @@ @fullName Error Loading Template @description -This error occurs when {@link api/ng.$compile `$compile`} attempts to fetch a template from some URL, and the request fails. +This error occurs when {@link ng.$compile `$compile`} attempts to fetch a template from some URL, and the request fails. To resolve this error, ensure that the URL of the template is spelled correctly and resolves to correct absolute URL. The [Chrome Developer Tools](https://developers.google.com/chrome-developer-tools/docs/network#network_panel_overview) might also be helpful in determining why the request failed. -If you are using {@link api/ng.$templateCache} to pre-load templates, ensure that the cache was populated with the template. +If you are using {@link ng.$templateCache} to pre-load templates, ensure that the cache was populated with the template. diff --git a/docs/content/error/controller/noscp.ngdoc b/docs/content/error/controller/noscp.ngdoc index 18a01e0c..26257546 100644 --- a/docs/content/error/controller/noscp.ngdoc +++ b/docs/content/error/controller/noscp.ngdoc @@ -3,7 +3,7 @@ @fullName Missing $scope object @description -This error occurs when {@link api/ng.$controller $controller} service is called in order to instantiate a new controller but no scope is provided via `$scope` property of the locals map. +This error occurs when {@link ng.$controller $controller} service is called in order to instantiate a new controller but no scope is provided via `$scope` property of the locals map. Example of incorrect usage that leads to this error: ``` @@ -18,4 +18,4 @@ To fix the example above please provide a scope to the $controller call: $controller(MyController, {$scope, newScope}); ``` -Please consult the {@link api/ng.$controller $controller} service api docs to learn more. +Please consult the {@link ng.$controller $controller} service api docs to learn more. diff --git a/docs/content/error/injector/cdep.ngdoc b/docs/content/error/injector/cdep.ngdoc index 0e9769c4..0e6526b8 100644 --- a/docs/content/error/injector/cdep.ngdoc +++ b/docs/content/error/injector/cdep.ngdoc @@ -3,7 +3,7 @@ @fullName Circular Dependency @description -This error occurs when the {@link api/angular.injector $injector} tries to get +This error occurs when the {@link angular.injector $injector} tries to get a service that depends on itself, either directly or indirectly. To fix this, construct your dependency chain such that there are no circular dependencies. diff --git a/docs/content/error/injector/modulerr.ngdoc b/docs/content/error/injector/modulerr.ngdoc index db3ca76b..4b92a5de 100644 --- a/docs/content/error/injector/modulerr.ngdoc +++ b/docs/content/error/injector/modulerr.ngdoc @@ -8,4 +8,4 @@ message above should provide additional context. In AngularJS `1.2.0` and later, `ngRoute` has been moved to its own module. If you are getting this error after upgrading to `1.2.x`, be sure that you've -installed {@link api/ngRoute `ngRoute`}. +installed {@link ngRoute `ngRoute`}. diff --git a/docs/content/error/injector/nomod.ngdoc b/docs/content/error/injector/nomod.ngdoc index 66e2a5ad..5f8fb1e6 100644 --- a/docs/content/error/injector/nomod.ngdoc +++ b/docs/content/error/injector/nomod.ngdoc @@ -5,7 +5,7 @@ This error occurs when trying to "re-open" a module that has not yet been defined. -To define a new module, call {@link api/angular.module angular.module} with a name +To define a new module, call {@link angular.module angular.module} with a name and an array of dependent modules, like so: ``` diff --git a/docs/content/error/injector/pget.ngdoc b/docs/content/error/injector/pget.ngdoc index c195767a..1772d348 100644 --- a/docs/content/error/injector/pget.ngdoc +++ b/docs/content/error/injector/pget.ngdoc @@ -22,5 +22,5 @@ angular.module("myApp", []) .provider('good', GoodProvider); ``` -For more information, refer to the {@link api/AUTO.$provide#methods_provider +For more information, refer to the {@link auto.$provide#methods_provider $provide.provider} api doc. \ No newline at end of file diff --git a/docs/content/error/interpolate/noconcat.ngdoc b/docs/content/error/interpolate/noconcat.ngdoc index c611b81a..0853544e 100644 --- a/docs/content/error/interpolate/noconcat.ngdoc +++ b/docs/content/error/interpolate/noconcat.ngdoc @@ -9,4 +9,4 @@ it hard to reason about whether some combination of concatenated values are unsafe to use and could easily lead to XSS. For more information about how AngularJS helps keep your app secure, refer to -the {@link api/ng.$sce $sce} API doc. \ No newline at end of file +the {@link ng.$sce $sce} API doc. \ No newline at end of file diff --git a/docs/content/error/jqLite/nosel.ngdoc b/docs/content/error/jqLite/nosel.ngdoc index 7009db6b..65df8f85 100644 --- a/docs/content/error/jqLite/nosel.ngdoc +++ b/docs/content/error/jqLite/nosel.ngdoc @@ -3,7 +3,7 @@ @fullName Unsupported Selector Lookup @description -In order to keep Angular small, Angular implements only a subset of the selectors in {@link api/angular.element#description_angulars-jqlite jqLite}. +In order to keep Angular small, Angular implements only a subset of the selectors in {@link angular.element#description_angulars-jqlite jqLite}. This error occurs when a jqLite instance is invoked with a selector other than this subset. In order to resolve this error, rewrite your code to only use tag name selectors and manually traverse the DOM using the APIs provided by jqLite. diff --git a/docs/content/error/location/ihshprfx.ngdoc b/docs/content/error/location/ihshprfx.ngdoc index cb1189dd..8acab933 100644 --- a/docs/content/error/location/ihshprfx.ngdoc +++ b/docs/content/error/location/ihshprfx.ngdoc @@ -3,7 +3,7 @@ @fullName Missing Hash Prefix @description -This error occurs when {@link api/ng.$location $location} service is configured to use a hash prefix but this prefix was not present in a url that the `$location` service was asked to parse. +This error occurs when {@link ng.$location $location} service is configured to use a hash prefix but this prefix was not present in a url that the `$location` service was asked to parse. For example if you configure `$location` service with prefix `'!'`: ``` diff --git a/docs/content/error/location/ipthprfx.ngdoc b/docs/content/error/location/ipthprfx.ngdoc index afbcda3f..55b75d86 100644 --- a/docs/content/error/location/ipthprfx.ngdoc +++ b/docs/content/error/location/ipthprfx.ngdoc @@ -3,6 +3,6 @@ @fullName Invalid or Missing Path Prefix @description -This error occurs when you configure the {@link api/ng.$location `$location`} service in the html5 mode, specify a base url for your application via `` element and try to update the location with a path that doesn't match the base prefix. +This error occurs when you configure the {@link ng.$location `$location`} service in the html5 mode, specify a base url for your application via `` element and try to update the location with a path that doesn't match the base prefix. To resolve this issue, please check the base url specified via the `` tag in the head of your main html document, as well as the url that you tried to set the location to. diff --git a/docs/content/error/location/isrcharg.ngdoc b/docs/content/error/location/isrcharg.ngdoc index 4f6f4b43..4b60ddd5 100644 --- a/docs/content/error/location/isrcharg.ngdoc +++ b/docs/content/error/location/isrcharg.ngdoc @@ -6,4 +6,4 @@ To resolve this error, ensure that the first argument for the `$location.search` call is a `string` or an object. You can use the stack trace associated with this error to identify the call site that caused this issue. -To learn more, please consult the {@link api/ng.$location `$location`} api docs. +To learn more, please consult the {@link ng.$location `$location`} api docs. diff --git a/docs/content/error/ngModel/nonassign.ngdoc b/docs/content/error/ngModel/nonassign.ngdoc index 33894c49..cc6e3f71 100644 --- a/docs/content/error/ngModel/nonassign.ngdoc +++ b/docs/content/error/ngModel/nonassign.ngdoc @@ -3,7 +3,7 @@ @fullName Non-Assignable Expression @description -This error occurs when expression the {@link api/ng.directive:ngModel ngModel} directive is bound to is a non-assignable expression. +This error occurs when expression the {@link ng.directive:ngModel ngModel} directive is bound to is a non-assignable expression. Examples using assignable expressions include: @@ -24,4 +24,4 @@ Examples of non-assignable expressions include: Always make sure that the expression bound via `ngModel` directive can be assigned to. -For more information, see the {@link api/ng.directive:ngModel ngModel API doc}. +For more information, see the {@link ng.directive:ngModel ngModel API doc}. diff --git a/docs/content/error/ngOptions/iexp.ngdoc b/docs/content/error/ngOptions/iexp.ngdoc index a4515048..47f387d8 100644 --- a/docs/content/error/ngOptions/iexp.ngdoc +++ b/docs/content/error/ngOptions/iexp.ngdoc @@ -10,4 +10,4 @@ Here's an example of correct syntax: ` control. - 2. the {@link api/ng.$interpolate {{name}} } interpolation - sets up a {@link api/ng.$rootScope.Scope#methods_$watch $watch} to be notified of + 2. the {@link ng.$interpolate {{name}} } interpolation + sets up a {@link ng.$rootScope.Scope#methods_$watch $watch} to be notified of `name` changes. 2. During the runtime phase: 1. Pressing an '`X`' key causes the browser to emit a `keydown` event on the input control. - 2. The {@link api/ng.directive:input input} directive + 2. The {@link ng.directive:input input} directive captures the change to the input's value and calls {@link api/ng.$rootScope.Scope#methods_$apply $apply}`("name = 'X';")` to update the application model inside the Angular execution context. 3. Angular applies the `name = 'X';` to the model. - 4. The {@link api/ng.$rootScope.Scope#methods_$digest $digest} loop begins - 5. The {@link api/ng.$rootScope.Scope#methods_$watch $watch} list detects a change - on the `name` property and notifies the {@link api/ng.$interpolate + 4. The {@link ng.$rootScope.Scope#methods_$digest $digest} loop begins + 5. The {@link ng.$rootScope.Scope#methods_$watch $watch} list detects a change + on the `name` property and notifies the {@link ng.$interpolate {{name}} } interpolation, which in turn updates the DOM. 6. Angular exits the execution context, which in turn exits the `keydown` event and with it the JavaScript execution context. diff --git a/docs/content/guide/templates.ngdoc b/docs/content/guide/templates.ngdoc index fdd90b74..bd8bfd89 100644 --- a/docs/content/guide/templates.ngdoc +++ b/docs/content/guide/templates.ngdoc @@ -12,7 +12,7 @@ These are the types of Angular elements and element attributes you can use in a * {@link guide/directive Directive} — An attribute or element that augments an existing DOM element or represents a reusable DOM component - a widget. -* {@link api/ng.$interpolate Markup} — The double +* {@link ng.$interpolate Markup} — The double curly brace notation `{{ }}` to bind expressions to elements is built-in angular markup. * {@link filter Filter} — Formats your data for display to the user. * {@link forms Form controls} — Lets you validate user input. @@ -41,8 +41,8 @@ with {@link expression expressions}: In a simple single-page app, the template consists of HTML, CSS, and angular directives contained in just one HTML file (usually `index.html`). In a more complex app, you can display multiple views within one main page using "partials", which are segments of template located in separate HTML -files. You "include" the partials in the main page using the {@link api/ngRoute.$route -$route} service in conjunction with the {@link api/ngRoute.directive:ngView ngView} directive. An +files. You "include" the partials in the main page using the {@link ngRoute.$route +$route} service in conjunction with the {@link ngRoute.directive:ngView ngView} directive. An example of this technique is shown in the {@link tutorial/ angular tutorial}, in steps seven and eight. @@ -54,4 +54,4 @@ eight. ## Related API -* {@link api/index API Reference} +* {@link ./api API Reference} diff --git a/docs/content/misc/faq.ngdoc b/docs/content/misc/faq.ngdoc index 18beca12..e416055e 100644 --- a/docs/content/misc/faq.ngdoc +++ b/docs/content/misc/faq.ngdoc @@ -79,7 +79,7 @@ in Angular. Yes, Angular can use [jQuery](http://jquery.com/) if it's present in your app when the application is being bootstrapped. If jQuery is not present in your script path, Angular falls back -to its own implementation of the subset of jQuery that we call {@link api/angular.element jQLite}. +to its own implementation of the subset of jQuery that we call {@link angular.element jQLite}. Due to a change to use `on()`/`off()` rather than `bind()`/`unbind()`, Angular 1.2 only operates with jQuery 1.7.1 or above. @@ -89,7 +89,7 @@ jQuery 1.7.1 or above. Very testable and designed this way from ground up. It has an integrated dependency injection framework, provides mocks for many heavy dependencies (server-side communication). See -{@link api/ng service} for details. +{@link ngMock} for details. ### How can I learn more about Angular? diff --git a/docs/content/misc/started.ngdoc b/docs/content/misc/started.ngdoc index a6301fa7..3ea5530d 100644 --- a/docs/content/misc/started.ngdoc +++ b/docs/content/misc/started.ngdoc @@ -36,4 +36,4 @@ tutorials. ##Read more The AngularJS documentation includes the {@link guide/index Developer Guide} covering concepts and the -{@link api/ API Reference} for syntax and usage. +{@link ./api API Reference} for syntax and usage. diff --git a/docs/content/tutorial/step_00.ngdoc b/docs/content/tutorial/step_00.ngdoc index 22bbe158..3a0dc070 100644 --- a/docs/content/tutorial/step_00.ngdoc +++ b/docs/content/tutorial/step_00.ngdoc @@ -118,7 +118,7 @@ __`app/index.html`:__ This code downloads the `angular.js` script and registers a callback that will be executed by the browser when the containing HTML page is fully downloaded. When the callback is executed, Angular -looks for the {@link api/ng.directive:ngApp ngApp} directive. If +looks for the {@link ng.directive:ngApp ngApp} directive. If Angular finds the directive, it will bootstrap the application with the root of the application DOM being the element on which the `ngApp` directive was defined. @@ -149,9 +149,9 @@ for most cases. In advanced cases, such as when using script loaders, you can us There are 3 important things that happen during the app bootstrap: -1. The {@link api/AUTO.$injector injector} that will be used for dependency injection is created. +1. The {@link auto.$injector injector} that will be used for dependency injection is created. -2. The injector will then create the {@link api/ng.$rootScope root scope} that will +2. The injector will then create the {@link ng.$rootScope root scope} that will become the context for the model of our application. 3. Angular will then "compile" the DOM starting at the `ngApp` root element, processing any diff --git a/docs/content/tutorial/step_02.ngdoc b/docs/content/tutorial/step_02.ngdoc index efafba91..37e91ef7 100644 --- a/docs/content/tutorial/step_02.ngdoc +++ b/docs/content/tutorial/step_02.ngdoc @@ -54,7 +54,7 @@ __`app/index.html`:__ ``` We replaced the hard-coded phone list with the -{@link api/ng.directive:ngRepeat ngRepeat directive} and two +{@link ng.directive:ngRepeat ngRepeat directive} and two {@link guide/expression Angular expressions} enclosed in curly braces: `{{phone.name}}` and `{{phone.snippet}}`: @@ -105,7 +105,7 @@ for our data model, the controller allows us to establish data-binding between the model and the view. We connected the dots between the presentation, data, and logic components as follows: -* The {@link api/ng.directive:ngController ngController} directive, located on the `` tag, +* The {@link ng.directive:ngController ngController} directive, located on the `` tag, references the name of our controller, `PhoneListCtrl` (located in the JavaScript file `controllers.js`). @@ -122,7 +122,7 @@ contained in the template, data model, and controller, to keep models and views sync. Any changes made to the model are reflected in the view; any changes that occur in the view are reflected in the model. -To learn more about Angular scopes, see the {@link api/ng.$rootScope.Scope angular scope documentation}. +To learn more about Angular scopes, see the {@link ng.$rootScope.Scope angular scope documentation}. ## Tests diff --git a/docs/content/tutorial/step_03.ngdoc b/docs/content/tutorial/step_03.ngdoc index 8866e49c..02069ebc 100644 --- a/docs/content/tutorial/step_03.ngdoc +++ b/docs/content/tutorial/step_03.ngdoc @@ -56,8 +56,8 @@ __`app/index.html`:__ ``` We added a standard HTML `` tag and used Angular's -{@link api/ng.filter:filter filter} function to process the input for the -{@link api/ng.directive:ngRepeat ngRepeat} directive. +{@link ng.filter:filter filter} function to process the input for the +{@link ng.directive:ngRepeat ngRepeat} directive. This lets a user enter search criteria and immediately see the effects of their search on the phone list. This new code demonstrates the following: @@ -72,7 +72,7 @@ the DOM to reflect the current state of the model. -* Use of the `filter` filter: The {@link api/ng.filter:filter filter} function uses the +* Use of the `filter` filter: The {@link ng.filter:filter filter} function uses the `query` value to create a new array that contains only those records that match the `query`. `ngRepeat` automatically updates the view in response to the changing number of phones returned @@ -162,8 +162,8 @@ and title elements: While using double curlies works fine within the title element, you might have noticed that for a split second they are actually displayed to the user while the page is loading. A better -solution would be to use the {@link api/ng.directive:ngBind -ngBind} or {@link api/ng.directive:ngBindTemplate +solution would be to use the {@link ng.directive:ngBind +ngBind} or {@link ng.directive:ngBindTemplate ngBindTemplate} directives, which are invisible to the user while the page is loading: Google Phone Gallery diff --git a/docs/content/tutorial/step_04.ngdoc b/docs/content/tutorial/step_04.ngdoc index adf362b6..cffc6319 100644 --- a/docs/content/tutorial/step_04.ngdoc +++ b/docs/content/tutorial/step_04.ngdoc @@ -49,7 +49,7 @@ two provided sorting options. -* We then chained the `filter` filter with {@link api/ng.filter:orderBy `orderBy`} +* We then chained the `filter` filter with {@link ng.filter:orderBy `orderBy`} filter to further process the input into the repeater. `orderBy` is a filter that takes an input array, copies it and reorders the copy which is then returned. diff --git a/docs/content/tutorial/step_05.ngdoc b/docs/content/tutorial/step_05.ngdoc index 357bbf5b..f717528d 100644 --- a/docs/content/tutorial/step_05.ngdoc +++ b/docs/content/tutorial/step_05.ngdoc @@ -42,7 +42,7 @@ Following is a sample of the file: ## Controller -We'll use Angular's {@link api/ng.$http $http} service in our controller to make an HTTP +We'll use Angular's {@link ng.$http $http} service in our controller to make an HTTP request to your web server to fetch the data in the `app/phones/phones.json` file. `$http` is just one of several built-in {@link guide/dev_guide.services angular services} that handle common operations in web apps. Angular injects these services for you where you need them. @@ -72,7 +72,7 @@ relative to our `index.html` file). The server responds by providing the data in browser and our app they both look the same. For the sake of simplicity we used a json file in this tutorial.) -The `$http` service returns a {@link api/ng.$q promise object} with a `success` +The `$http` service returns a {@link ng.$q promise object} with a `success` method. We call this method to handle the asynchronous response and assign the phone data to the scope controlled by this controller, as a model called `phones`. Notice that angular detected the json response and parsed it for us! @@ -193,15 +193,15 @@ describe('PhoneCat controllers', function() { ``` Note: Because we loaded Jasmine and `angular-mocks.js` in our test environment, we got two helper -methods {@link api/angular.mock.module module} and {@link api/angular.mock.inject inject} that we'll +methods {@link angular.mock.module module} and {@link angular.mock.inject inject} that we'll use to access and configure the injector. We created the controller in the test environment, as follows: * We used the `inject` helper method to inject instances of -{@link api/ng.$rootScope $rootScope}, -{@link api/ng.$controller $controller} and -{@link api/ng.$httpBackend $httpBackend} services into the Jasmine's `beforeEach` +{@link ng.$rootScope $rootScope}, +{@link ng.$controller $controller} and +{@link ng.$httpBackend $httpBackend} services into the Jasmine's `beforeEach` function. These instances come from an injector which is recreated from scratch for every single test. This guarantees that each test starts from a well known starting point and each test is isolated from the work done in other tests. diff --git a/docs/content/tutorial/step_07.ngdoc b/docs/content/tutorial/step_07.ngdoc index de3bdae6..4c45f2d4 100644 --- a/docs/content/tutorial/step_07.ngdoc +++ b/docs/content/tutorial/step_07.ngdoc @@ -35,8 +35,8 @@ our application. Other "partial templates" are then included into this layout te the current "route" — the view that is currently displayed to the user. Application routes in Angular are declared via the -{@link api/ngRoute.$routeProvider $routeProvider}, which is the provider of the -{@link api/ngRoute.$route $route service}. This service makes it easy to wire together +{@link ngRoute.$routeProvider $routeProvider}, which is the provider of the +{@link ngRoute.$route $route service}. This service makes it easy to wire together controllers, view templates, and the current URL location in the browser. Using this feature we can implement [deep linking](http://en.wikipedia.org/wiki/Deep_linking), which lets us utilize the browser's history (back and forward navigation) and bookmarks. @@ -106,7 +106,7 @@ module `phonecatControllers`. By listing these two modules as dependencies of `p can use the directives and services they provide. Thus using the `config` API we request the `$routeProvider` to be injected into our config function -and use the {@link api/ngRoute.$routeProvider#when `$routeProvider.when`} API to define our routes. +and use the {@link ngRoute.$routeProvider#when `$routeProvider.when`} API to define our routes. Our application routes are defined as follows: @@ -126,11 +126,11 @@ address doesn't match either of our routes. Note the use of the `:phoneId` parameter in the second route declaration. The `$route` service uses the route declaration — `'/phones/:phoneId'` — as a template that is matched against the current URL. All variables defined with the `:` notation are extracted into the -{@link api/ngRoute.$routeParams `$routeParams`} object. +{@link ngRoute.$routeParams `$routeParams`} object. In order for our application to bootstrap with our newly created module we'll also need to specify -the module name as the value of the {@link api/ng.directive:ngApp ngApp} +the module name as the value of the {@link ng.directive:ngApp ngApp} directive: __`app/index.html`:__ @@ -172,7 +172,7 @@ Because our example app is relatively small, we'll add all of our controllers to ## Template -The `$route` service is usually used in conjunction with the {@link api/ngRoute.directive:ngView +The `$route` service is usually used in conjunction with the {@link ngRoute.directive:ngView ngView} directive. The role of the `ngView` directive is to include the view template for the current route into the layout template. This makes it a perfect fit for our `index.html` template. diff --git a/docs/content/tutorial/step_08.ngdoc b/docs/content/tutorial/step_08.ngdoc index 02c03773..25de2cb8 100644 --- a/docs/content/tutorial/step_08.ngdoc +++ b/docs/content/tutorial/step_08.ngdoc @@ -16,7 +16,7 @@ phone in the phone list. Now when you click on a phone on the list, the phone details page with phone-specific information is displayed. -To implement the phone details view we will use {@link api/ng.$http $http} to fetch +To implement the phone details view we will use {@link ng.$http $http} to fetch our data, and we'll flesh out the `phone-detail.html` view template. The most important changes are listed below. You can see the full diff on [GitHub](https://github.com/angular/angular-phonecat/compare/step-7...step-8): diff --git a/docs/content/tutorial/step_09.ngdoc b/docs/content/tutorial/step_09.ngdoc index 0e32001d..2bac44b8 100644 --- a/docs/content/tutorial/step_09.ngdoc +++ b/docs/content/tutorial/step_09.ngdoc @@ -113,7 +113,7 @@ our filter tests execute. This call loads our `phonecatFilters` module into the for this test run. Note that we call the helper function, `inject(function(checkmarkFilter) { ... })`, to get -access to the filter that we want to test. See {@link api/angular.mock.inject angular.mock.inject()}. +access to the filter that we want to test. See {@link angular.mock.inject angular.mock.inject()}. You should now see the following output in the Karma tab: @@ -122,7 +122,7 @@ You should now see the following output in the Karma tab: # Experiments -* Let's experiment with some of the {@link api/ng.$filterProvider built-in Angular filters} and add the +* Let's experiment with some of the {@link ng.$filterProvider built-in Angular filters} and add the following bindings to `index.html`: * `{{ "lower cap string" | uppercase }}` * `{{ {foo: "bar", baz: 23} | json }}` diff --git a/docs/content/tutorial/step_10.ngdoc b/docs/content/tutorial/step_10.ngdoc index b16ceaab..d1d3f9c4 100644 --- a/docs/content/tutorial/step_10.ngdoc +++ b/docs/content/tutorial/step_10.ngdoc @@ -65,7 +65,7 @@ __`app/partials/phone-detail.html`:__ We bound the `ngSrc` directive of the large image to the `mainImageUrl` property. -We also registered an {@link api/ng.directive:ngClick `ngClick`} +We also registered an {@link ng.directive:ngClick `ngClick`} handler with thumbnail images. When a user clicks on one of the thumbnail images, the handler will use the `setImage` event handler function to change the value of the `mainImageUrl` property to the URL of the thumbnail image. diff --git a/docs/content/tutorial/step_11.ngdoc b/docs/content/tutorial/step_11.ngdoc index b3308cc6..3d86191b 100644 --- a/docs/content/tutorial/step_11.ngdoc +++ b/docs/content/tutorial/step_11.ngdoc @@ -53,7 +53,7 @@ of the service - 'Phone' - and the factory function. The factory function is sim controller's constructor in that both can declare dependencies via function arguments. The Phone service declared a dependency on the `$resource` service. -The {@link api/ngResource.$resource `$resource`} service makes it easy to create a +The {@link ngResource.$resource `$resource`} service makes it easy to create a [RESTful](http://en.wikipedia.org/wiki/Representational_State_Transfer) client with just a few lines of code. This client can then be used in our application, instead of the lower-level {@link api/ng.$http $http} service. @@ -72,8 +72,8 @@ We need to add the 'phonecatServices' module dependency to 'phonecatApp' module' ## Controller We simplified our sub-controllers (`PhoneListCtrl` and `PhoneDetailCtrl`) by factoring out the -lower-level {@link api/ng.$http $http} service, replacing it with a new service called -`Phone`. Angular's {@link api/ngResource.$resource `$resource`} service is easier to +lower-level {@link ng.$http $http} service, replacing it with a new service called +`Phone`. Angular's {@link ngResource.$resource `$resource`} service is easier to use than `$http` for interacting with data sources exposed as RESTful resources. It is also easier now to understand what the code in our controllers is doing. @@ -128,7 +128,7 @@ We have modified our unit tests to verify that our new service is issuing HTTP r processing them as expected. The tests also check that our controllers are interacting with the service correctly. -The {@link api/ngResource.$resource $resource} service augments the response object +The {@link ngResource.$resource $resource} service augments the response object with methods for updating and deleting the resource. If we were to use the standard `toEqual` matcher, our tests would fail because the test values would not match the responses exactly. To solve the problem, we use a newly-defined `toEqualData` [Jasmine matcher](https://github.com/pivotal/jasmine/wiki/Matchers). When the -- cgit v1.2.3