From a4405d7c6f509c25a0813af16778ae8f5ba1d9c6 Mon Sep 17 00:00:00 2001 From: Brandon Roberts Date: Thu, 28 Jun 2018 13:53:13 -0500 Subject: [PATCH] docs(forms): update API reference for reactive and template-driven forms modules (#25687) PR Close #25687 --- packages/forms/src/form_providers.ts | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/packages/forms/src/form_providers.ts b/packages/forms/src/form_providers.ts index a0759331f8..03b9a015ad 100644 --- a/packages/forms/src/form_providers.ts +++ b/packages/forms/src/form_providers.ts @@ -15,8 +15,10 @@ import {FormBuilder} from './form_builder'; /** - * The ng module for forms. + * @description + * An `NgModule` that registers the directives and providers for template-driven forms. * + * @see [Forms Guide](/guide/forms) */ @NgModule({ declarations: TEMPLATE_DRIVEN_DIRECTIVES, @@ -27,8 +29,11 @@ export class FormsModule { } /** - * The ng module for reactive forms. + * @description + * An `NgModule` that registers the directives and providers for reactive forms. * + * @see [Reactive Forms Guide](/guide/reactive-forms) + * */ @NgModule({ declarations: [REACTIVE_DRIVEN_DIRECTIVES], @@ -36,6 +41,13 @@ export class FormsModule { exports: [InternalFormsSharedModule, REACTIVE_DRIVEN_DIRECTIVES] }) export class ReactiveFormsModule { + /** + * @description + * Provides options for configuring the reactive forms module. + * + * @param opts An object of configuration options `warnOnNgModelWithFormControl` Configures when + * to emit a warning when an `ngModel binding is used with reactive form directives. + */ static withConfig(opts: { /** @deprecated as of v6 */ warnOnNgModelWithFormControl: 'never' | 'once' | 'always' }): ModuleWithProviders {