From 0a065bbdcff022f7d38b6408956335112952887c Mon Sep 17 00:00:00 2001 From: Pete Bacon Darwin Date: Thu, 5 Apr 2018 10:40:58 +0100 Subject: [PATCH] docs(forms): migrate deprecated `@howToUse` tags (#23186) In this case they have been converted to `@description` tags. PR Close #23186 --- packages/forms/src/directives/ng_form.ts | 2 +- packages/forms/src/directives/ng_model.ts | 2 +- packages/forms/src/directives/ng_model_group.ts | 2 +- .../forms/src/directives/radio_control_value_accessor.ts | 2 +- .../reactive_directives/form_control_directive.ts | 2 +- .../src/directives/reactive_directives/form_control_name.ts | 2 +- .../directives/reactive_directives/form_group_directive.ts | 2 +- .../src/directives/reactive_directives/form_group_name.ts | 4 ++-- .../forms/src/directives/select_control_value_accessor.ts | 4 ++-- packages/forms/src/form_builder.ts | 2 +- packages/forms/src/model.ts | 6 +++--- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/packages/forms/src/directives/ng_form.ts b/packages/forms/src/directives/ng_form.ts index 94fc94ef45..c46b6c6e32 100644 --- a/packages/forms/src/directives/ng_form.ts +++ b/packages/forms/src/directives/ng_form.ts @@ -29,7 +29,7 @@ const resolvedPromise = Promise.resolve(null); * @whatItDoes Creates a top-level {@link FormGroup} instance and binds it to a form * to track aggregate form value and validation status. * - * @howToUse + * @description * * As soon as you import the `FormsModule`, this directive becomes active by default on * all `
` tags. You don't need to add a special selector. diff --git a/packages/forms/src/directives/ng_model.ts b/packages/forms/src/directives/ng_model.ts index f98d68b1a8..a0457bc6bf 100644 --- a/packages/forms/src/directives/ng_model.ts +++ b/packages/forms/src/directives/ng_model.ts @@ -54,7 +54,7 @@ const resolvedPromise = Promise.resolve(null); * within a parent form, the directive will also register itself with the form as a child * control. * - * @howToUse + * @description * * This directive can be used by itself or as part of a larger form. All you need is the * `ngModel` selector to activate it. diff --git a/packages/forms/src/directives/ng_model_group.ts b/packages/forms/src/directives/ng_model_group.ts index f463c3ec78..b260f8ce04 100644 --- a/packages/forms/src/directives/ng_model_group.ts +++ b/packages/forms/src/directives/ng_model_group.ts @@ -23,7 +23,7 @@ export const modelGroupProvider: any = { /** * @whatItDoes Creates and binds a {@link FormGroup} instance to a DOM element. * - * @howToUse + * @description * * This directive can only be used as a child of {@link NgForm} (or in other words, * within `` tags). diff --git a/packages/forms/src/directives/radio_control_value_accessor.ts b/packages/forms/src/directives/radio_control_value_accessor.ts index 75af9de4aa..f322723e0f 100644 --- a/packages/forms/src/directives/radio_control_value_accessor.ts +++ b/packages/forms/src/directives/radio_control_value_accessor.ts @@ -60,7 +60,7 @@ export class RadioControlRegistry { * Used by {@link NgModel}, {@link FormControlDirective}, and {@link FormControlName} * to keep the view synced with the {@link FormControl} model. * - * @howToUse + * @description * * If you have imported the {@link FormsModule} or the {@link ReactiveFormsModule}, this * value accessor will be active on any radio control that has a form directive. You do diff --git a/packages/forms/src/directives/reactive_directives/form_control_directive.ts b/packages/forms/src/directives/reactive_directives/form_control_directive.ts index 8f36a785ad..80f5051056 100644 --- a/packages/forms/src/directives/reactive_directives/form_control_directive.ts +++ b/packages/forms/src/directives/reactive_directives/form_control_directive.ts @@ -36,7 +36,7 @@ export const formControlBinding: any = { * any values written to the DOM element through user input will be reflected in the * {@link FormControl} instance (view -> model). * - * @howToUse + * @description * * Use this directive if you'd like to create and manage a {@link FormControl} instance directly. * Simply create a {@link FormControl}, save it to your component class, and pass it into the diff --git a/packages/forms/src/directives/reactive_directives/form_control_name.ts b/packages/forms/src/directives/reactive_directives/form_control_name.ts index 04747e608f..1e2f833c41 100644 --- a/packages/forms/src/directives/reactive_directives/form_control_name.ts +++ b/packages/forms/src/directives/reactive_directives/form_control_name.ts @@ -36,7 +36,7 @@ export const controlNameBinding: any = { * any values written to the DOM element through user input will be reflected in the * {@link FormControl} instance (view -> model). * - * @howToUse + * @description * * This directive is designed to be used with a parent {@link FormGroupDirective} (selector: * `[formGroup]`). diff --git a/packages/forms/src/directives/reactive_directives/form_group_directive.ts b/packages/forms/src/directives/reactive_directives/form_group_directive.ts index f172bcab77..0aa86ed8e5 100644 --- a/packages/forms/src/directives/reactive_directives/form_group_directive.ts +++ b/packages/forms/src/directives/reactive_directives/form_group_directive.ts @@ -25,7 +25,7 @@ export const formDirectiveProvider: any = { /** * @whatItDoes Binds an existing {@link FormGroup} to a DOM element. * - * @howToUse + * @description * * This directive accepts an existing {@link FormGroup} instance. It will then use this * {@link FormGroup} instance to match any child {@link FormControl}, {@link FormGroup}, diff --git a/packages/forms/src/directives/reactive_directives/form_group_name.ts b/packages/forms/src/directives/reactive_directives/form_group_name.ts index 68434d1b0b..02903d609d 100644 --- a/packages/forms/src/directives/reactive_directives/form_group_name.ts +++ b/packages/forms/src/directives/reactive_directives/form_group_name.ts @@ -26,7 +26,7 @@ export const formGroupNameProvider: any = { /** * @whatItDoes Syncs a nested {@link FormGroup} to a DOM element. * - * @howToUse + * @description * * This directive can only be used with a parent {@link FormGroupDirective} (selector: * `[formGroup]`). @@ -97,7 +97,7 @@ export const formArrayNameProvider: any = { /** * @whatItDoes Syncs a nested {@link FormArray} to a DOM element. * - * @howToUse + * @description * * This directive is designed to be used with a parent {@link FormGroupDirective} (selector: * `[formGroup]`). diff --git a/packages/forms/src/directives/select_control_value_accessor.ts b/packages/forms/src/directives/select_control_value_accessor.ts index 127470237b..363d4d319d 100644 --- a/packages/forms/src/directives/select_control_value_accessor.ts +++ b/packages/forms/src/directives/select_control_value_accessor.ts @@ -32,7 +32,7 @@ function _extractId(valueString: string): string { * Used by {@link NgModel}, {@link FormControlDirective}, and {@link FormControlName} * to keep the view synced with the {@link FormControl} model. * - * @howToUse + * @description * * If you have imported the {@link FormsModule} or the {@link ReactiveFormsModule}, this * value accessor will be active on any select control that has a form directive. You do @@ -160,7 +160,7 @@ export class SelectControlValueAccessor implements ControlValueAccessor { /** * @whatItDoes Marks `