Class description goes here. This is a short and to the point one or two sentence description that easily introduces the reader to the class.
+
+ class Compiler {
+ compileModuleSync<T>(moduleType: Type<T>): NgModuleFactory<T>
+ compileModuleAsync<T>(moduleType: Type<T>): Promise<NgModuleFactory<T>>
+ compileModuleAndAllComponentsSync<T>(moduleType: Type<T>): ModuleWithComponentFactories<T>
+ compileModuleAndAllComponentsAsync<T>(moduleType: Type<T>): Promise<ModuleWithComponentFactories<T>>
+ clearCache(): void
+ clearCacheFor(type: Type<any>)
+ }
+ The longer class description goes here which can include multiple paragraphs.
+ Bacon ipsum dolor amet pork belly capicola sirloin venison alcatra ground round ham hock jowl turkey picanha bresaola pancetta brisket chicken fatback. Burgdoggen kevin salami jowl shoulder jerky leberkas meatball. Ham hock picanha burgdoggen pork belly rump bacon cupim. Bacon kielbasa sirloin shank strip steak ground round. Bresaola cow salami meatloaf pork chop leberkas flank turducken biltong meatball chuck pork tri-tip chicken. Ribeye corned beef shoulder, meatloaf strip steak jerky porchetta capicola alcatra ham. +
+ constructor(element: any, keyframes: {
+ [key: string]: string | number;
+ }[], duration: number, delay: number, easing: string, previousPlayers: any[])
+ | Property | +Type | +Description | +
|---|---|---|
+ Property1
+ |
+ + | Description goes here | +
+ Property2
+ |
+ Type | +Description goes here | +
+ Property3
+ |
+ Type | +Description goes here | +
| Method1Name( ) | +
|---|
|
+ Description goes here ++ Bacon ipsum dolor amet pork belly capicola sirloin venison alcatra ground round ham hock jowl turkey picanha bresaola pancetta brisket chicken fatback. Burgdoggen kevin salami jowl shoulder jerky leberkas meatball. Ham hock picanha burgdoggen pork belly rump bacon cupim. Bacon kielbasa sirloin shank strip steak ground round. Bresaola cow salami meatloaf pork chop leberkas flank turducken biltong meatball chuck pork tri-tip chicken. Ribeye corned beef shoulder, meatloaf strip steak jerky porchetta capicola alcatra ham. + |
+
| Method2Name( ) | +||||
|---|---|---|---|---|
|
+ Description goes here ++ Declaration+
+
+ Parameters+Returns+Returns information and results goes here. +Errors+Error information goes here ++ Further details provided as needed. Bacon ipsum dolor amet pork belly capicola sirloin venison alcatra ground round ham hock jowl turkey picanha bresaola pancetta brisket chicken fatback. Burgdoggen kevin salami jowl shoulder jerky leberkas meatball. + Overloads+
+ Example: Descriptive Title of Method Example+Bacon ipsum dolor amet pork belly capicola sirloin venison alcatra ground round ham hock jowl turkey picanha bresaola pancetta brisket chicken fatback. Burgdoggen kevin salami jowl shoulder jerky leberkas meatball. Ham hock picanha burgdoggen pork belly rump bacon cupim. Bacon kielbasa sirloin shank strip steak ground round. Bresaola cow salami meatloaf pork chop leberkas flank turducken biltong meatball chuck pork tri-tip chicken. Ribeye corned beef shoulder, meatloaf strip steak jerky porchetta capicola alcatra ham. + |
+
Intro description text about what the example is and how it can be used.
+
+ constructor(element: any, keyframes: {
+ [key: string]: string | number;
+ }[], duration: number, delay: number, easing: string, previousPlayers: any[])
+ Further explanation provided as needed. Bacon ipsum dolor amet pork belly capicola sirloin venison alcatra ground round ham hock jowl turkey picanha bresaola pancetta brisket chicken fatback. Burgdoggen kevin salami jowl shoulder jerky leberkas meatball.
+{$ doc.whatItDoes | marked $}
+ {% include "includes/security-notes.html" %} + {% include "includes/deprecation.html" %} + {% block overview %} + {% include "includes/class-overview.html" %} + {% endblock %} + {% block details %} + {% block additional %}{% endblock %} + {% include "includes/description.html" %} + {$ memberHelpers.renderProperties(doc.staticProperties, 'static-properties', 'static-property', 'Static Properties') $} + {$ memberHelpers.renderMethodDetails(doc.staticMethods, 'static-methods', 'static-method', 'Static Methods') $} + {% if doc.constructorDoc %}{$ memberHelpers.renderMethodDetail(doc.constructorDoc, 'constructor') $}{% endif %} + {$ memberHelpers.renderProperties(doc.properties, 'instance-properties', 'instance-property', 'Properties') $} + + {$ memberHelpers.renderMethodDetails(doc.methods, 'instance-methods', 'instance-method', 'Methods') $} + + {% block annotations %}{% include "includes/annotations.html" %}{% endblock %} + {% endblock %} + {% include "includes/how-to-use.html" %} {% endblock %} diff --git a/aio/tools/transforms/templates/api/decorator.template.html b/aio/tools/transforms/templates/api/decorator.template.html index 232b99b40d..c4d3f77e1a 100644 --- a/aio/tools/transforms/templates/api/decorator.template.html +++ b/aio/tools/transforms/templates/api/decorator.template.html @@ -5,5 +5,5 @@ {% block overview %}{% include "includes/decorator-overview.html" %}{% endblock %} {% block details %} {% include "includes/description.html" %} - {$ memberHelper.renderMemberDetails(doc.members, 'metadata-members', 'metadata-member', 'Metadata Properties') $} + {$ memberHelper.renderProperties(doc.members, 'metadata-members', 'metadata-member', 'Metadata Properties') $} {% endblock %} diff --git a/aio/tools/transforms/templates/api/export-base.template.html b/aio/tools/transforms/templates/api/export-base.template.html index 6b23a7e9db..f1d3c5be92 100644 --- a/aio/tools/transforms/templates/api/export-base.template.html +++ b/aio/tools/transforms/templates/api/export-base.template.html @@ -1,7 +1,6 @@ {% extends 'base.template.html' -%} {% block body %} - {% include "includes/info-bar.html" %} {% include "includes/what-it-does.html" %} {% include "includes/security-notes.html" %} {% include "includes/deprecation.html" %} diff --git a/aio/tools/transforms/templates/api/includes/class-overview.html b/aio/tools/transforms/templates/api/includes/class-overview.html index e7ddf7862f..dd5ad7ccdc 100644 --- a/aio/tools/transforms/templates/api/includes/class-overview.html +++ b/aio/tools/transforms/templates/api/includes/class-overview.html @@ -2,13 +2,23 @@{$ descendant.name $}{$ descendant.name $}
+ {$ renderDescendantList(descendant.descendants | filterByPropertyValue('docType', docType), docType, recursed) $}
{$ method.name $}() |
|---|
| + {% if method.description %}{$ method.description | marked $}{% endif %} + | +
| + {$ renderOverloadInfo(method, cssClass + '-overload', method) $} + | +
| + {$ renderOverloadInfo(overload, cssClass + '-overload', method) $} + | +
|
+
+
+
+ |
+
There are no parameters.
+{%- endif -%} +{%- endmacro -%} \ No newline at end of file diff --git a/aio/yarn.lock b/aio/yarn.lock index 4acead46b1..409398dfce 100644 --- a/aio/yarn.lock +++ b/aio/yarn.lock @@ -2312,9 +2312,9 @@ devtools-timeline-model@1.1.6: chrome-devtools-frontend "1.0.401423" resolve "1.1.7" -dgeni-packages@^0.24.0: - version "0.24.0" - resolved "https://registry.yarnpkg.com/dgeni-packages/-/dgeni-packages-0.24.0.tgz#2f995f78fecd6a9ded72d7bdccbbc4c46360c1ea" +dgeni-packages@0.24.1: + version "0.24.1" + resolved "https://registry.yarnpkg.com/dgeni-packages/-/dgeni-packages-0.24.1.tgz#e3e99eb82615b30a9e43fe1a9bb9911ff6bbf913" dependencies: canonical-path "0.0.2" catharsis "^0.8.1" diff --git a/packages/forms/src/model.ts b/packages/forms/src/model.ts index 4342cffad0..d9f28b534a 100644 --- a/packages/forms/src/model.ts +++ b/packages/forms/src/model.ts @@ -117,6 +117,9 @@ function isOptionsObj( * that are shared between all sub-classes, like `value`, `valid`, and `dirty`. It shouldn't be * instantiated directly. * + * @see [Forms Guide](/guide/forms) + * @see [Reactive Forms Guide](/guide/reactive-forms) + * @see [Dynamic Forms Guide](/guide/dynamic-form) * @stable */ export abstract class AbstractControl { @@ -136,6 +139,12 @@ export abstract class AbstractControl { private _asyncValidationSubscription: any; public readonly value: any; + /** + * Initialize the AbstractControl instance. + * @param validator The function that will determine the synchronous validity of this control. + * @param asyncValidator The function that will determine the asynchronous validity of this + * control. + */ constructor(public validator: ValidatorFn|null, public asyncValidator: AsyncValidatorFn|null) {} /** @@ -1033,10 +1042,6 @@ export class FormGroup extends AbstractControl { * Sets the value of the {@link FormGroup}. It accepts an object that matches * the structure of the group, with control names as keys. * - * This method performs strict checks, so it will throw an error if you try - * to set the value of a control that doesn't exist or if you exclude the - * value of a control. - * * ### Example * * ``` @@ -1050,6 +1055,9 @@ export class FormGroup extends AbstractControl { * console.log(form.value); // {first: 'Nancy', last: 'Drew'} * * ``` + * @throws This method performs strict checks, so it will throw an error if you try + * to set the value of a control that doesn't exist or if you exclude the + * value of a control. */ setValue(value: {[key: string]: any}, options: {onlySelf?: boolean, emitEvent?: boolean} = {}): void {