docs(common): migrate @whatItDoes tags to the description (#23062)

We get the overview for the doc by splitting off the first
paragraph.

PR Close #23062
This commit is contained in:
Pete Bacon Darwin
2018-03-29 11:12:34 +01:00
committed by Igor Minar
parent 46ba7f69dd
commit 079d8e57d5
20 changed files with 58 additions and 53 deletions

View File

@ -124,9 +124,10 @@ function formatNumberToLocaleString(
/**
* @ngModule CommonModule
* @whatItDoes Formats a number as currency using locale rules.
* @description
*
* Formats a number as currency using locale rules.
*
* Use `currency` to format a number as currency.
*
* Where:
@ -158,10 +159,9 @@ export function formatCurrency(
/**
* @ngModule CommonModule
* @whatItDoes Formats a number as a percentage according to locale rules.
* @description
*
* Formats a number as percentage.
* Formats a number as a percentage according to locale rules.
*
* Where:
* - `value` is a number.
@ -181,7 +181,6 @@ export function formatPercent(value: number, locale: string, digitsInfo?: string
/**
* @ngModule CommonModule
* @whatItDoes Formats a number according to locale rules.
* @description
*
* Formats a number as text. Group sizing and separator and other locale-specific