cargdev/angular
1
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(upgrade): migrate deprecatd @whatItDoes tags (#23197)

Browse Source 
These tags' contents  are now included in the `@description` tag.

PR Close #23197
This commit is contained in:
Pete Bacon Darwin
2018-04-05 16:39:51 +01:00
committed by Igor Minar
parent 5dc50e4688
commit 9d9fb607cd
4 changed files with 40 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
packages/upgrade/src/common/downgrade_component.ts
View File

@ -19,21 +19,15 @@ interface Thenable<T> {
}
/**
* @whatItDoes
* @description
*
* A helper function that allows an Angular component to be used from AngularJS.
*
* *Part of the [upgrade/static](api?query=upgrade%2Fstatic)
* library for hybrid upgrade apps that support AoT compilation*
*
* Allows an Angular component to be used from AngularJS.
*
* @description
*
* A helper function that returns a factory function to be used for registering an
* AngularJS wrapper directive for "downgrading" an Angular component.
*
* The parameter contains information about the Component that is being downgraded:
*
* * `component: Type<any>`: The type of the Component that will be downgraded
* This helper function returns a factory function to be used for registering
* an AngularJS wrapper directive for "downgrading" an Angular component.
*
* ### Examples
*
@ -49,6 +43,13 @@ interface Thenable<T> {
*
* {@example upgrade/static/ts/module.ts region="ng2-heroes-wrapper"}
*
* @param info contains information about the Component that is being downgraded:
*
* * `component: Type<any>`: The type of the Component that will be downgraded
*
* @returns a factory function that can be used to register the component in an
* AngularJS module.
*
* @experimental
*/
export function downgradeComponent(info: {

22
packages/upgrade/src/common/downgrade_injectable.ts
View File

@ -10,22 +10,15 @@ import {Injector} from '@angular/core';
import {INJECTOR_KEY} from './constants';
/**
* @whatItDoes
* @description
*
* A helper function to allow an Angular service to be accessible from AngularJS.
*
* *Part of the [upgrade/static](api?query=upgrade%2Fstatic)
* library for hybrid upgrade apps that support AoT compilation*
*
* Allow an Angular service to be accessible from AngularJS.
*
* @description
*
* Takes a `token` that identifies a service provided from Angular.
*
* Returns a [factory function](https://docs.angularjs.org/guide/di) that can be
* used to register the service on an AngularJS module.
*
* The factory function provides access to the Angular service that
* is identified by the `token` parameter.
* This helper function returns a factory function that provides access to the Angular
* service identified by the `token` parameter.
*
* ### Examples
*
@ -49,6 +42,11 @@ import {INJECTOR_KEY} from './constants';
*
* {@example upgrade/static/ts/module.ts region="example-app"}
*
* @param token an `InjectionToken` that identifies a service provided from Angular.
*
* @returns a [factory function](https://docs.angularjs.org/guide/di) that can be
* used to register the service on an AngularJS module.
*
* @experimental
*/
export function downgradeInjectable(token: any): Function {