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

docs(router): migrate deprecated @howToUse tags (#23187)

Browse Source 
These have been converted to `@usageNotes` or included in the
`@description` tag.

PR Close #23187
This commit is contained in:
Pete Bacon Darwin
2018-04-05 11:38:57 +01:00
committed by Igor Minar
parent 92821e338b
commit f66f408b04
10 changed files with 52 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
packages/router/src/router_state.ts
View File

@ -21,7 +21,12 @@ import {Tree, TreeNode} from './utils/tree';
/**
* @whatItDoes Represents the state of the router.
*
* @howToUse
* @description
*
* RouterState is a tree of activated routes. Every node in this tree knows about the "consumed" URL
* segments, the extracted parameters, and the resolved data.
*
* ### Example
*
* ```
* @Component({templateUrl:'template.html'})
@ -36,10 +41,6 @@ import {Tree, TreeNode} from './utils/tree';
* }
* ```
*
* @description
* RouterState is a tree of activated routes. Every node in this tree knows about the "consumed" URL
* segments, the extracted parameters, and the resolved data.
*
* See {@link ActivatedRoute} for more information.
*
* @stable
@ -88,7 +89,7 @@ export function createEmptyStateSnapshot(
* outlet.
* An `ActivatedRoute` can also be used to traverse the router state tree.
*
* @howToUse
* @description
*
* ```
* @Component({...})
@ -233,7 +234,7 @@ function flattenInherited(pathFromRoot: ActivatedRouteSnapshot[]): Inherited {
* at a particular moment in time. ActivatedRouteSnapshot can also be used to traverse the router
* state tree.
*
* @howToUse
* @description
*
* ```
* @Component({templateUrl:'./my-component.html'})
@ -328,7 +329,12 @@ export class ActivatedRouteSnapshot {
/**
* @whatItDoes Represents the state of the router at a moment in time.
*
* @howToUse
* @description
*
* RouterStateSnapshot is a tree of activated route snapshots. Every node in this tree knows about
* the "consumed" URL segments, the extracted parameters, and the resolved data.
*
* ### Example
*
* ```
* @Component({templateUrl:'template.html'})
@ -344,10 +350,6 @@ export class ActivatedRouteSnapshot {
* }
* ```
*
* @description
* RouterStateSnapshot is a tree of activated route snapshots. Every node in this tree knows about
* the "consumed" URL segments, the extracted parameters, and the resolved data.
*
* @stable
*/
export class RouterStateSnapshot extends Tree<ActivatedRouteSnapshot> {