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

docs(upgrade): migrate deprecated @howToUse tags (#23197)

Browse Source 
These have become examples in the `@description` tag.

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

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

@ -26,7 +26,16 @@ interface Thenable<T> {
*
* Allows an Angular component to be used from AngularJS.
*
* @howToUse
* @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
*
* ### Examples
*
* Let's assume that you have an Angular component called `ng2Heroes` that needs
* to be made available in AngularJS templates.
@ -40,15 +49,6 @@ interface Thenable<T> {
*
* {@example upgrade/static/ts/module.ts region="ng2-heroes-wrapper"}
*
* @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
*
* @experimental
*/
export function downgradeComponent(info: {

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

@ -17,7 +17,17 @@ import {INJECTOR_KEY} from './constants';
*
* Allow an Angular service to be accessible from AngularJS.
*
* @howToUse
* @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.
*
* ### Examples
*
* First ensure that the service to be downgraded is provided in an {@link NgModule}
* that will be part of the upgrade application. For example, let's assume we have
@ -39,16 +49,6 @@ import {INJECTOR_KEY} from './constants';
*
* {@example upgrade/static/ts/module.ts region="example-app"}
*
* @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.
*
* @experimental
*/
export function downgradeInjectable(token: any): Function {