docs(upgrade): remove unnecessary `{@link... }` tags (#23197)

Backtick enclosed inline code blocks will be automatically linked
if appropriate.

PR Close #23197
This commit is contained in:
Pete Bacon Darwin 2018-04-05 16:41:52 +01:00 committed by Igor Minar
parent 9d9fb607cd
commit b8053f1d4f
5 changed files with 19 additions and 19 deletions

View File

@ -244,14 +244,14 @@ try {
} }
/** /**
* @deprecated Use {@link setAngularJSGlobal} instead. * @deprecated Use `setAngularJSGlobal` instead.
*/ */
export function setAngularLib(ng: any): void { export function setAngularLib(ng: any): void {
setAngularJSGlobal(ng); setAngularJSGlobal(ng);
} }
/** /**
* @deprecated Use {@link getAngularJSGlobal} instead. * @deprecated Use `getAngularJSGlobal` instead.
*/ */
export function getAngularLib(): any { export function getAngularLib(): any {
return getAngularJSGlobal(); return getAngularJSGlobal();

View File

@ -22,13 +22,13 @@ import {INJECTOR_KEY} from './constants';
* *
* ### Examples * ### Examples
* *
* First ensure that the service to be downgraded is provided in an {@link NgModule} * First ensure that the service to be downgraded is provided in an `NgModule`
* that will be part of the upgrade application. For example, let's assume we have * that will be part of the upgrade application. For example, let's assume we have
* defined `HeroesService` * defined `HeroesService`
* *
* {@example upgrade/static/ts/module.ts region="ng2-heroes-service"} * {@example upgrade/static/ts/module.ts region="ng2-heroes-service"}
* *
* and that we have included this in our upgrade app {@link NgModule} * and that we have included this in our upgrade app `NgModule`
* *
* {@example upgrade/static/ts/module.ts region="ng2-module"} * {@example upgrade/static/ts/module.ts region="ng2-module"}
* *

View File

@ -313,7 +313,7 @@ export class UpgradeAdapter {
* ``` * ```
* *
* @param modules any AngularJS modules that the upgrade module should depend upon * @param modules any AngularJS modules that the upgrade module should depend upon
* @returns an {@link UpgradeAdapterRef}, which lets you register a `ready()` callback to * @returns an `UpgradeAdapterRef`, which lets you register a `ready()` callback to
* run assertions once the Angular components are ready to test through AngularJS. * run assertions once the Angular components are ready to test through AngularJS.
*/ */
registerForNg1Tests(modules?: string[]): UpgradeAdapterRef { registerForNg1Tests(modules?: string[]): UpgradeAdapterRef {

View File

@ -44,12 +44,12 @@ class Bindings {
* *
* {@example upgrade/static/ts/module.ts region="ng1-hero"} * {@example upgrade/static/ts/module.ts region="ng1-hero"}
* *
* We must create a {@link Directive} that will make this AngularJS component * We must create a `Directive` that will make this AngularJS component
* available inside Angular templates. * available inside Angular templates.
* *
* {@example upgrade/static/ts/module.ts region="ng1-hero-wrapper"} * {@example upgrade/static/ts/module.ts region="ng1-hero-wrapper"}
* *
* In this example you can see that we must derive from the {@link UpgradeComponent} * In this example you can see that we must derive from the `UpgradeComponent`
* base class but also provide an {@link Directive `@Directive`} decorator. This is * base class but also provide an {@link Directive `@Directive`} decorator. This is
* because the AoT compiler requires that this information is statically available at * because the AoT compiler requires that this information is statically available at
* compile time. * compile time.
@ -60,7 +60,7 @@ class Bindings {
* * derive from `UpgradeComponent` * * derive from `UpgradeComponent`
* * call the base class from the constructor, passing * * call the base class from the constructor, passing
* * the AngularJS name of the component (`ng1Hero`) * * the AngularJS name of the component (`ng1Hero`)
* * the {@link ElementRef} and {@link Injector} for the component wrapper * * the `ElementRef` and `Injector` for the component wrapper
* *
* @experimental * @experimental
*/ */

View File

@ -30,14 +30,14 @@ import {NgAdapterInjector} from './util';
* *
* Specifically, the classes and functions in the `upgrade/static` module allow the following: * Specifically, the classes and functions in the `upgrade/static` module allow the following:
* 1. Creation of an Angular directive that wraps and exposes an AngularJS component so * 1. Creation of an Angular directive that wraps and exposes an AngularJS component so
* that it can be used in an Angular template. See {@link UpgradeComponent}. * that it can be used in an Angular template. See `UpgradeComponent`.
* 2. Creation of an AngularJS directive that wraps and exposes an Angular component so * 2. Creation of an AngularJS directive that wraps and exposes an Angular component so
* that it can be used in an AngularJS template. See {@link downgradeComponent}. * that it can be used in an AngularJS template. See `downgradeComponent`.
* 3. Creation of an Angular root injector provider that wraps and exposes an AngularJS * 3. Creation of an Angular root injector provider that wraps and exposes an AngularJS
* service so that it can be injected into an Angular context. See * service so that it can be injected into an Angular context. See
* {@link UpgradeModule#upgrading-an-angular-1-service Upgrading an AngularJS service} below. * {@link UpgradeModule#upgrading-an-angular-1-service Upgrading an AngularJS service} below.
* 4. Creation of an AngularJS service that wraps and exposes an Angular injectable * 4. Creation of an AngularJS service that wraps and exposes an Angular injectable
* so that it can be injected into an AngularJS context. See {@link downgradeInjectable}. * so that it can be injected into an AngularJS context. See `downgradeInjectable`.
* 3. Bootstrapping of a hybrid Angular application which contains both of the frameworks * 3. Bootstrapping of a hybrid Angular application which contains both of the frameworks
* coexisting in a single application. See the * coexisting in a single application. See the
* {@link UpgradeModule#examples example} below. * {@link UpgradeModule#examples example} below.
@ -58,10 +58,10 @@ import {NgAdapterInjector} from './util';
* where they are instantiated. * where they are instantiated.
* 5. An AngularJS component can be "upgraded"" to an Angular component. This is achieved by * 5. An AngularJS component can be "upgraded"" to an Angular component. This is achieved by
* defining an Angular directive, which bootstraps the AngularJS component at its location * defining an Angular directive, which bootstraps the AngularJS component at its location
* in the DOM. See {@link UpgradeComponent}. * in the DOM. See `UpgradeComponent`.
* 6. An Angular component can be "downgraded"" to an AngularJS component. This is achieved by * 6. An Angular component can be "downgraded"" to an AngularJS component. This is achieved by
* defining an AngularJS directive, which bootstraps the Angular component at its location * defining an AngularJS directive, which bootstraps the Angular component at its location
* in the DOM. See {@link downgradeComponent}. * in the DOM. See `downgradeComponent`.
* 7. Whenever an "upgraded"/"downgraded" component is instantiated the host element is owned by * 7. Whenever an "upgraded"/"downgraded" component is instantiated the host element is owned by
* the framework doing the instantiation. The other framework then instantiates and owns the * the framework doing the instantiation. The other framework then instantiates and owns the
* view for that component. * view for that component.
@ -77,7 +77,7 @@ import {NgAdapterInjector} from './util';
* to `$apply()`. * to `$apply()`.
* *
* ### Core AngularJS services * ### Core AngularJS services
* Importing this {@link NgModule} will add providers for the core * Importing this `NgModule` will add providers for the core
* [AngularJS services](https://docs.angularjs.org/api/ng/service) to the root injector. * [AngularJS services](https://docs.angularjs.org/api/ng/service) to the root injector.
* *
* ### Bootstrap * ### Bootstrap
@ -86,16 +86,16 @@ import {NgAdapterInjector} from './util';
* DOM for the hybrid upgrade app. * DOM for the hybrid upgrade app.
* *
* It also contains properties to access the {@link UpgradeModule#injector root injector}, the * It also contains properties to access the {@link UpgradeModule#injector root injector}, the
* bootstrap {@link NgZone} and the * bootstrap `NgZone` and the
* [AngularJS $injector](https://docs.angularjs.org/api/auto/service/$injector). * [AngularJS $injector](https://docs.angularjs.org/api/auto/service/$injector).
* *
* ### Examples * ### Examples
* *
* Import the {@link UpgradeModule} into your top level {@link NgModule Angular `NgModule`}. * Import the `UpgradeModule` into your top level {@link NgModule Angular `NgModule`}.
* *
* {@example upgrade/static/ts/module.ts region='ng2-module'} * {@example upgrade/static/ts/module.ts region='ng2-module'}
* *
* Then bootstrap the hybrid upgrade app's module, get hold of the {@link UpgradeModule} instance * Then bootstrap the hybrid upgrade app's module, get hold of the `UpgradeModule` instance
* and use it to bootstrap the top level [AngularJS * and use it to bootstrap the top level [AngularJS
* module](https://docs.angularjs.org/api/ng/type/angular.Module). * module](https://docs.angularjs.org/api/ng/type/angular.Module).
* *
@ -112,7 +112,7 @@ import {NgAdapterInjector} from './util';
* *
* {@example upgrade/static/ts/module.ts region="ng1-title-case-service"} * {@example upgrade/static/ts/module.ts region="ng1-title-case-service"}
* *
* Then you should define an Angular provider to be included in your {@link NgModule} `providers` * Then you should define an Angular provider to be included in your `NgModule` `providers`
* property. * property.
* *
* {@example upgrade/static/ts/module.ts region="upgrade-ng1-service"} * {@example upgrade/static/ts/module.ts region="upgrade-ng1-service"}
@ -134,7 +134,7 @@ export class UpgradeModule {
public injector: Injector; public injector: Injector;
constructor( constructor(
/** The root {@link Injector} for the upgrade application. */ /** The root `Injector` for the upgrade application. */
injector: Injector, injector: Injector,
/** The bootstrap zone for the upgrade application */ /** The bootstrap zone for the upgrade application */
public ngZone: NgZone) { public ngZone: NgZone) {