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

@ -11,8 +11,6 @@ import {Directive, EmbeddedViewRef, Input, OnChanges, SimpleChange, SimpleChange
/**
* @ngModule CommonModule
*
* @whatItDoes Inserts an embedded view from a prepared `TemplateRef`
*
* @usageNotes
* ```
* <ng-container *ngTemplateOutlet="templateRefExp; context: contextExp"></ng-container>
@ -20,6 +18,8 @@ import {Directive, EmbeddedViewRef, Input, OnChanges, SimpleChange, SimpleChange
*
* @description
*
* Inserts an embedded view from a prepared `TemplateRef`.
*
* You can attach a context object to the `EmbeddedViewRef` by setting `[ngTemplateOutletContext]`.
* `[ngTemplateOutletContext]` should be an object, the object's keys will be available for binding
* by the local template `let` declarations.