From b8053f1d4f96f5b16e4a490ff944c6cb76c1e5e8 Mon Sep 17 00:00:00 2001 From: Pete Bacon Darwin Date: Thu, 5 Apr 2018 16:41:52 +0100 Subject: [PATCH] docs(upgrade): remove unnecessary `{@link... }` tags (#23197) Backtick enclosed inline code blocks will be automatically linked if appropriate. PR Close #23197 --- packages/upgrade/src/common/angular1.ts | 4 ++-- .../src/common/downgrade_injectable.ts | 4 ++-- .../upgrade/src/dynamic/upgrade_adapter.ts | 2 +- .../upgrade/src/static/upgrade_component.ts | 6 ++--- packages/upgrade/src/static/upgrade_module.ts | 22 +++++++++---------- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/packages/upgrade/src/common/angular1.ts b/packages/upgrade/src/common/angular1.ts index cfcfa9179e..d7047dde68 100644 --- a/packages/upgrade/src/common/angular1.ts +++ b/packages/upgrade/src/common/angular1.ts @@ -244,14 +244,14 @@ try { } /** - * @deprecated Use {@link setAngularJSGlobal} instead. + * @deprecated Use `setAngularJSGlobal` instead. */ export function setAngularLib(ng: any): void { setAngularJSGlobal(ng); } /** - * @deprecated Use {@link getAngularJSGlobal} instead. + * @deprecated Use `getAngularJSGlobal` instead. */ export function getAngularLib(): any { return getAngularJSGlobal(); diff --git a/packages/upgrade/src/common/downgrade_injectable.ts b/packages/upgrade/src/common/downgrade_injectable.ts index 358982d1c7..64c13fc7c0 100644 --- a/packages/upgrade/src/common/downgrade_injectable.ts +++ b/packages/upgrade/src/common/downgrade_injectable.ts @@ -22,13 +22,13 @@ import {INJECTOR_KEY} from './constants'; * * ### 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 * defined `HeroesService` * * {@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"} * diff --git a/packages/upgrade/src/dynamic/upgrade_adapter.ts b/packages/upgrade/src/dynamic/upgrade_adapter.ts index d41b49cf6b..6bacc19591 100644 --- a/packages/upgrade/src/dynamic/upgrade_adapter.ts +++ b/packages/upgrade/src/dynamic/upgrade_adapter.ts @@ -313,7 +313,7 @@ export class UpgradeAdapter { * ``` * * @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. */ registerForNg1Tests(modules?: string[]): UpgradeAdapterRef { diff --git a/packages/upgrade/src/static/upgrade_component.ts b/packages/upgrade/src/static/upgrade_component.ts index 8cb6a6d198..009482db2e 100644 --- a/packages/upgrade/src/static/upgrade_component.ts +++ b/packages/upgrade/src/static/upgrade_component.ts @@ -44,12 +44,12 @@ class Bindings { * * {@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. * * {@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 * because the AoT compiler requires that this information is statically available at * compile time. @@ -60,7 +60,7 @@ class Bindings { * * derive from `UpgradeComponent` * * call the base class from the constructor, passing * * 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 */ diff --git a/packages/upgrade/src/static/upgrade_module.ts b/packages/upgrade/src/static/upgrade_module.ts index 843cc15582..93d1b16a61 100644 --- a/packages/upgrade/src/static/upgrade_module.ts +++ b/packages/upgrade/src/static/upgrade_module.ts @@ -30,14 +30,14 @@ import {NgAdapterInjector} from './util'; * * 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 - * 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 - * 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 * service so that it can be injected into an Angular context. See * {@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 - * 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 * coexisting in a single application. See the * {@link UpgradeModule#examples example} below. @@ -58,10 +58,10 @@ import {NgAdapterInjector} from './util'; * where they are instantiated. * 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 - * 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 * 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 * the framework doing the instantiation. The other framework then instantiates and owns the * view for that component. @@ -77,7 +77,7 @@ import {NgAdapterInjector} from './util'; * to `$apply()`. * * ### 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. * * ### Bootstrap @@ -86,16 +86,16 @@ import {NgAdapterInjector} from './util'; * DOM for the hybrid upgrade app. * * 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). * * ### 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'} * - * 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 * 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"} * - * 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. * * {@example upgrade/static/ts/module.ts region="upgrade-ng1-service"} @@ -134,7 +134,7 @@ export class UpgradeModule { public injector: Injector; constructor( - /** The root {@link Injector} for the upgrade application. */ + /** The root `Injector` for the upgrade application. */ injector: Injector, /** The bootstrap zone for the upgrade application */ public ngZone: NgZone) {