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

@ -16,8 +16,6 @@ import {SwitchView} from './ng_switch';
/**
* @ngModule CommonModule
*
* @whatItDoes Adds / removes DOM sub-trees based on a numeric value. Tailored for pluralization.
*
* @usageNotes
* ```
* <some-element [ngPlural]="value">
@ -29,6 +27,8 @@ import {SwitchView} from './ng_switch';
*
* @description
*
* Adds / removes DOM sub-trees based on a numeric value. Tailored for pluralization.
*
* Displays DOM sub-trees that match the switch expression value, or failing that, DOM sub-trees
* that match the switch expression's pluralization category.
*
@ -83,8 +83,10 @@ export class NgPlural {
/**
* @ngModule CommonModule
*
* @whatItDoes Creates a view that will be added/removed from the parent {@link NgPlural} when the
* given expression matches the plural expression according to CLDR rules.
* @description
*
* Creates a view that will be added/removed from the parent {@link NgPlural} when the
* given expression matches the plural expression according to CLDR rules.
*
* @usageNotes
* ```