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

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

Browse Source 
The first line of the description is now used as an overview.

PR Close #23187
This commit is contained in:
Pete Bacon Darwin
2018-04-05 11:51:21 +01:00
committed by Igor Minar
parent f66f408b04
commit 31b90436b4
16 changed files with 184 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -19,10 +19,10 @@ import {Tree, TreeNode} from './utils/tree';
/**
* @whatItDoes Represents the state of the router.
*
* @description
*
* Represents the state of the router.
*
* 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.
*
@ -85,12 +85,11 @@ export function createEmptyStateSnapshot(
}
/**
* @whatItDoes Contains the information about a route associated with a component loaded in an
* outlet.
* An `ActivatedRoute` can also be used to traverse the router state tree.
*
* @description
*
* Contains the information about a route associated with a component loaded in an
* outlet. An `ActivatedRoute` can also be used to traverse the router state tree.
*
* ```
* @Component({...})
* class MyComponent {
@ -229,13 +228,12 @@ function flattenInherited(pathFromRoot: ActivatedRouteSnapshot[]): Inherited {
}
/**
* @whatItDoes Contains the information about a route associated with a component loaded in an
* outlet
* at a particular moment in time. ActivatedRouteSnapshot can also be used to traverse the router
* state tree.
*
* @description
*
* Contains the information about a route associated with a component loaded in an
* outlet at a particular moment in time. ActivatedRouteSnapshot can also be used to
* traverse the router state tree.
*
* ```
* @Component({templateUrl:'./my-component.html'})
* class MyComponent {
@ -327,11 +325,11 @@ export class ActivatedRouteSnapshot {
}
/**
* @whatItDoes Represents the state of the router at a moment in time.
*
* @description
*
* RouterStateSnapshot is a tree of activated route snapshots. Every node in this tree knows about
* Represents the state of the router at a moment in time.
*
* This 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