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

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

PR Close #23187

packages/router/src/router_module.ts

@@ -29,13 +29,19 @@ import {flatten} from './utils/collection';
 
 
 /**
- * @whatItDoes Contains a list of directives
+ * @description
+ *
+ * Contains a list of directives
+ *
  * @stable
  */
 const ROUTER_DIRECTIVES = [RouterOutlet, RouterLink, RouterLinkWithHref, RouterLinkActive];
 
 /**
- * @whatItDoes Is used in DI to configure the router.
+ * @description
+ *
+ * Is used in DI to configure the router.
+ *
  * @stable
  */
 export const ROUTER_CONFIGURATION = new InjectionToken<ExtraOptions>('ROUTER_CONFIGURATION');
@@ -71,8 +77,6 @@ export function routerNgProbeToken() {
 }
 
 /**
- * @whatItDoes Adds router directives and providers.
- *
  * @usageNotes
  *
  * RouterModule can be imported multiple times: once per lazily-loaded bundle.
@@ -107,6 +111,8 @@ export function routerNgProbeToken() {
  *
  * @description
  *
+ * Adds router directives and providers.
+ *
  * Managing state transitions is one of the hardest parts of building applications. This is
  * especially true on the web, where you also need to ensure that the state is reflected in the URL.
  * In addition, we often want to split applications into multiple bundles and load them on demand.
@@ -193,10 +199,10 @@ export function provideForRootGuard(router: Router): any {
 }
 
 /**
- * @whatItDoes Registers routes.
- *
  * @description
  *
+ * Registers routes.
+ *
  * ### Example
  *
  * ```
@@ -217,9 +223,10 @@ export function provideRoutes(routes: Routes): any {
 }
 
 /**
- * @whatItDoes Represents an option to configure when the initial navigation is performed.
- *
  * @description
+ *
+ * Represents an option to configure when the initial navigation is performed.
+ *
  * * 'enabled' - the initial navigation starts before the root component is created.
  * The bootstrap is blocked until the initial navigation is complete.
  * * 'disabled' - the initial navigation is not performed. The location listener is set up before
@@ -244,7 +251,9 @@ export type InitialNavigation =
     true | false | 'enabled' | 'disabled' | 'legacy_enabled' | 'legacy_disabled';
 
 /**
- * @whatItDoes Represents options to configure the router.
+ * @description
+ *
+ * Represents options to configure the router.
  *
  * @stable
  */