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

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

View File

@ -16,7 +16,7 @@ import {ChildrenOutletContexts, ExtraOptions, NoPreloading, PreloadingStrategy,
/**
* @whatItDoes Allows to simulate the loading of ng modules in tests.
*
* @howToUse
* @description
*
* ```
* const loader = TestBed.get(NgModuleFactoryLoader);
@ -133,7 +133,13 @@ export function setupTestingRouter(
/**
* @whatItDoes Sets up the router to be used for testing.
*
* @howToUse
* @description
*
* The modules sets up the router to be used for testing.
* It provides spy implementations of {@link Location}, {@link LocationStrategy}, and {@link
* NgModuleFactoryLoader}.
*
* ### Example
*
* ```
* beforeEach(() => {
@ -147,12 +153,6 @@ export function setupTestingRouter(
* });
* ```
*
* @description
*
* The modules sets up the router to be used for testing.
* It provides spy implementations of {@link Location}, {@link LocationStrategy}, and {@link
* NgModuleFactoryLoader}.
*
* @stable
*/
@NgModule({