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

docs(upgrade): move examples etc into @usageNotes (#26039)

Browse Source 
PR Close #26039
This commit is contained in:
Pete Bacon Darwin
2018-09-20 14:43:43 +01:00
committed by Kara Erickson
parent c08549ae38
commit fef9cebed0
5 changed files with 27 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
packages/upgrade/src/dynamic/upgrade_adapter.ts
View File

@ -30,7 +30,8 @@ let upgradeCount: number = 0;
* 3. Bootstrapping of a hybrid Angular application which contains both of the frameworks
* coexisting in a single application.
*
* ## Mental Model
* @usageNotes
* ### Mental Model
*
* When reasoning about how a hybrid application works it is useful to have a mental model which
* describes what is happening and explains what is happening at the lowest level.
@ -134,7 +135,8 @@ export class UpgradeAdapter {
* Angular Component. The adapter will bootstrap Angular component from within the
* AngularJS template.
*
* ## Mental Model
* @usageNotes
* ### Mental Model
*
* 1. The component is instantiated by being listed in AngularJS template. This means that the
* host element is controlled by AngularJS, but the component's view will be controlled by
@ -146,7 +148,7 @@ export class UpgradeAdapter {
* by way of the `ControlValueAccessor` interface from @angular/forms. Only components that
* implement this interface are eligible.
*
* ## Supported Features
* ### Supported Features
*
* - Bindings:
* - Attribute: `<comp name="World">`
@ -199,13 +201,14 @@ export class UpgradeAdapter {
* directive. The adapter will bootstrap AngularJS component from within the Angular
* template.
*
* ## Mental Model
* @usageNotes
* ### Mental Model
*
* 1. The component is instantiated by being listed in Angular template. This means that the
* host element is controlled by Angular, but the component's view will be controlled by
* AngularJS.
*
* ## Supported Features
* ### Supported Features
*
* - Bindings:
* - Attribute: `<comp name="World">`
@ -283,6 +286,7 @@ export class UpgradeAdapter {
* Use this instead of `angular.mock.module()` to load the upgrade module into
* the AngularJS testing injector.
*
* @usageNotes
* ### Example
*
* ```
@ -339,6 +343,7 @@ export class UpgradeAdapter {
* [`bootstrap`](https://docs.angularjs.org/api/ng/function/angular.bootstrap) method. Unlike
* AngularJS, this bootstrap is asynchronous.
*
* @usageNotes
* ### Example
*
* ```
@ -412,7 +417,7 @@ export class UpgradeAdapter {
/**
* Allows AngularJS service to be accessible from Angular.
*
*
* @usageNotes
* ### Example
*
* ```
@ -452,7 +457,7 @@ export class UpgradeAdapter {
/**
* Allows Angular service to be accessible from AngularJS.
*
*
* @usageNotes
* ### Example
*
* ```
@ -481,6 +486,7 @@ export class UpgradeAdapter {
* @param modules The AngularJS modules that this upgrade module should depend upon.
* @returns The AngularJS upgrade module that is declared by this method
*
* @usageNotes
* ### Example
*
* ```