From 57461e9ed77389a9eead24e67c73e908db9dfead Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Thu, 16 Feb 2017 10:26:53 -0800 Subject: [PATCH] docs(router): fix guards API docs (#14528) --- modules/@angular/router/src/interfaces.ts | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/modules/@angular/router/src/interfaces.ts b/modules/@angular/router/src/interfaces.ts index fce709da66..ca61e72d36 100644 --- a/modules/@angular/router/src/interfaces.ts +++ b/modules/@angular/router/src/interfaces.ts @@ -13,7 +13,7 @@ import {ActivatedRouteSnapshot, RouterStateSnapshot} from './router_state'; /** - * @whatItDoes Indicates that a class can implement to be a guard deciding if a route can be + * @whatItDoes Interface that a class can implement to be a guard deciding if a route can be * activated. * * @howToUse @@ -53,7 +53,7 @@ import {ActivatedRouteSnapshot, RouterStateSnapshot} from './router_state'; * class AppModule {} * ``` * - * You can also provide a function with the same signature instead of the class: + * You can alternatively provide a function with the `canActivate` signature: * * ``` * @NgModule({ @@ -84,7 +84,7 @@ export interface CanActivate { } /** - * @whatItDoes Indicates that a class can implement to be a guard deciding if a child route can be + * @whatItDoes Interface that a class can implement to be a guard deciding if a child route can be * activated. * * @howToUse @@ -129,7 +129,7 @@ export interface CanActivate { * class AppModule {} * ``` * - * You can also provide a function with the same signature instead of the class: + * You can alternatively provide a function with the `canActivateChild` signature: * * ``` * @NgModule({ @@ -159,14 +159,13 @@ export interface CanActivate { * * @stable */ - export interface CanActivateChild { canActivateChild(childRoute: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable|Promise|boolean; } /** - * @whatItDoes Indicates that a class can implement to be a guard deciding if a route can be + * @whatItDoes Interface that a class can implement to be a guard deciding if a route can be * deactivated. * * @howToUse @@ -208,7 +207,7 @@ export interface CanActivateChild { * class AppModule {} * ``` * - * You can also provide a function with the same signature instead of the class: + * You can alternatively provide a function with the `canDeactivate` signature: * * ``` * @NgModule({ @@ -241,7 +240,7 @@ export interface CanDeactivate { } /** - * @whatItDoes Indicates that class can implement to be a data provider. + * @whatItDoes Interface that class can implement to be a data provider. * * @howToUse * @@ -281,7 +280,7 @@ export interface CanDeactivate { * class AppModule {} * ``` * - * You can also provide a function with the same signature instead of the class. + * You can alternatively provide a function with the `resolve` signature: * * ``` * @NgModule({ @@ -313,7 +312,7 @@ export interface Resolve { /** - * @whatItDoes Indicates that a class can implement to be a guard deciding if a children can be + * @whatItDoes Interface that a class can implement to be a guard deciding if a children can be * loaded. * * @howToUse @@ -353,7 +352,7 @@ export interface Resolve { * class AppModule {} * ``` * - * You can also provide a function with the same signature instead of the class: + * You can alternatively provide a function with the `canLoad` signature: * * ``` * @NgModule({