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/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 ++++---- 10 files changed, 32 insertions(+), 32 deletions(-) (limited to 'docs/content/tutorial') 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