docs(core): migrate @whatItDoes tags to the description (#23185)

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

PR Close #23185
This commit is contained in:
Pete Bacon Darwin
2018-04-05 10:16:31 +01:00
committed by Igor Minar
parent 5bb14a68d2
commit 7dc150c1e8
11 changed files with 81 additions and 56 deletions

View File

@ -21,9 +21,6 @@ import {ViewEncapsulation} from './view';
*/
export interface DirectiveDecorator {
/**
* @whatItDoes Marks a class as an Angular directive and collects directive configuration
* metadata.
*
* @usageNotes
*
* ```
@ -38,6 +35,9 @@ export interface DirectiveDecorator {
*
* @description
*
* Marks a class as an Angular directive and collects directive configuration
* metadata.
*
* Directive decorator allows you to mark a class as an Angular directive and provide additional
* metadata that determines how the directive should be processed, instantiated and used at
* runtime.
@ -410,14 +410,14 @@ export const Directive: DirectiveDecorator =
*/
export interface ComponentDecorator {
/**
* @whatItDoes Marks a class as an Angular component and collects component configuration
* metadata.
*
* @usageNotes
*
* {@example core/ts/metadata/metadata.ts region='component'}
*
* @description
* Marks a class as an Angular component and collects component configuration
* metadata.
*
* Component decorator allows you to mark a class as an Angular component and provide additional
* metadata that determines how the component should be processed, instantiated and used at
* runtime.