cargdev/angular
1
0
Fork 0
Code Issues 17 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

24
packages/router/src/interfaces.ts
View File

@ -13,11 +13,10 @@ import {ActivatedRouteSnapshot, RouterStateSnapshot} from './router_state';
/**
* @whatItDoes Interface that a class can implement to be a guard deciding if a route can be
* activated.
*
* @description
*
* Interface that a class can implement to be a guard deciding if a route can be activated.
*
* ```
* class UserToken {}
* class Permissions {
@ -84,11 +83,10 @@ export interface CanActivate {
}
/**
* @whatItDoes Interface that a class can implement to be a guard deciding if a child route can be
* activated.
*
* @description
*
* Interface that a class can implement to be a guard deciding if a child route can be activated.
*
* ```
* class UserToken {}
* class Permissions {
@ -165,11 +163,10 @@ export interface CanActivateChild {
}
/**
* @whatItDoes Interface that a class can implement to be a guard deciding if a route can be
* deactivated.
*
* @description
*
* Interface that a class can implement to be a guard deciding if a route can be deactivated.
*
* ```
* class UserToken {}
* class Permissions {
@ -240,10 +237,10 @@ export interface CanDeactivate<T> {
}
/**
* @whatItDoes Interface that class can implement to be a data provider.
*
* @description
*
* Interface that class can implement to be a data provider.
*
* ```
* class Backend {
* fetchTeam(id: string) {
@ -312,11 +309,10 @@ export interface Resolve<T> {
/**
* @whatItDoes Interface that a class can implement to be a guard deciding if a children can be
* loaded.
*
* @description
*
* Interface that a class can implement to be a guard deciding if a children can be loaded.
*
* ```
* class UserToken {}
* class Permissions {