docs(upgrade): add API docs for downgradeModule() (#18487) (#18487)

PR Close #18487

PR Close #18487
This commit is contained in:
Georgios Kalpakas
2017-08-02 17:03:17 +03:00
committed by Jason Aden
parent ca0a55f4ee
commit 2ac2ab7ff6
12 changed files with 508 additions and 40 deletions

View File

@ -34,14 +34,14 @@ interface Thenable<T> {
* Let's assume that you have an Angular component called `ng2Heroes` that needs
* to be made available in AngularJS templates.
*
* {@example upgrade/static/ts/module.ts region="ng2-heroes"}
* {@example upgrade/static/ts/full/module.ts region="ng2-heroes"}
*
* We must create an AngularJS [directive](https://docs.angularjs.org/guide/directive)
* that will make this Angular component available inside AngularJS templates.
* The `downgradeComponent()` function returns a factory function that we
* can use to define the AngularJS directive that wraps the "downgraded" component.
*
* {@example upgrade/static/ts/module.ts region="ng2-heroes-wrapper"}
* {@example upgrade/static/ts/full/module.ts region="ng2-heroes-wrapper"}
*
* @param info contains information about the Component that is being downgraded:
*

View File

@ -26,21 +26,21 @@ import {INJECTOR_KEY} from './constants';
* 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"}
* {@example upgrade/static/ts/full/module.ts region="ng2-heroes-service"}
*
* and that we have included this in our upgrade app `NgModule`
*
* {@example upgrade/static/ts/module.ts region="ng2-module"}
* {@example upgrade/static/ts/full/module.ts region="ng2-module"}
*
* Now we can register the `downgradeInjectable` factory function for the service
* on an AngularJS module.
*
* {@example upgrade/static/ts/module.ts region="downgrade-ng2-heroes-service"}
* {@example upgrade/static/ts/full/module.ts region="downgrade-ng2-heroes-service"}
*
* Inside an AngularJS component's controller we can get hold of the
* downgraded service via the name we gave when downgrading.
*
* {@example upgrade/static/ts/module.ts region="example-app"}
* {@example upgrade/static/ts/full/module.ts region="example-app"}
*
* @param token an `InjectionToken` that identifies a service provided from Angular.
*