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

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

View File

@ -13,11 +13,11 @@ import {UpgradeModule} from '@angular/upgrade/static';
/**
* @whatItDoes Creates an initializer that in addition to setting up the Angular
* router sets up the ngRoute integration.
*
* @description
*
* Creates an initializer that in addition to setting up the Angular
* router sets up the ngRoute integration.
*
* ```
* @NgModule({
* imports: [
@ -50,7 +50,9 @@ export function locationSyncBootstrapListener(ngUpgrade: UpgradeModule) {
}
/**
* @whatItDoes Sets up a location synchronization.
* @description
*
* Sets up a location synchronization.
*
* History.pushState does not fire onPopState, so the Angular location
* doesn't detect it. The workaround is to attach a location change listener