docs(forms): migrate deprecated `@howToUse` tags (#23186)
In this case they have been converted to `@description` tags. PR Close #23186
This commit is contained in:
parent
8ea15b4f12
commit
0a065bbdcf
|
@ -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 `<form>` tags. You don't need to add a special selector.
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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 `<form>` tags).
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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]`).
|
||||
|
|
|
@ -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},
|
||||
|
|
|
@ -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]`).
|
||||
|
|
|
@ -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 `<option>` as dynamic, so Angular can be notified when options change.
|
||||
*
|
||||
* @howToUse
|
||||
* @description
|
||||
*
|
||||
* See docs for {@link SelectControlValueAccessor} for usage examples.
|
||||
*
|
||||
|
|
|
@ -18,7 +18,7 @@ import {AbstractControl, FormArray, FormControl, FormGroup} from './model';
|
|||
* `new FormControl()`, and `new FormArray()` boilerplate that can build up in larger
|
||||
* forms.
|
||||
*
|
||||
* @howToUse
|
||||
* @description
|
||||
*
|
||||
* To use, inject `FormBuilder` into your component class. You can then call its methods
|
||||
* directly.
|
||||
|
|
|
@ -673,7 +673,7 @@ export abstract class AbstractControl {
|
|||
* It is one of the three fundamental building blocks of Angular forms, along with
|
||||
* {@link FormGroup} and {@link FormArray}.
|
||||
*
|
||||
* @howToUse
|
||||
* @description
|
||||
*
|
||||
* When instantiating a {@link FormControl}, you can pass in an initial value as the
|
||||
* first argument. Example:
|
||||
|
@ -917,7 +917,7 @@ export class FormControl extends AbstractControl {
|
|||
* `FormGroup` is one of the three fundamental building blocks used to define forms in Angular,
|
||||
* along with {@link FormControl} and {@link FormArray}.
|
||||
*
|
||||
* @howToUse
|
||||
* @description
|
||||
*
|
||||
* When instantiating a {@link FormGroup}, pass in a collection of child controls as the first
|
||||
* argument. The key for each child will be the name under which it is registered.
|
||||
|
@ -1260,7 +1260,7 @@ export class FormGroup extends AbstractControl {
|
|||
* `FormArray` is one of the three fundamental building blocks used to define forms in Angular,
|
||||
* along with {@link FormControl} and {@link FormGroup}.
|
||||
*
|
||||
* @howToUse
|
||||
* @description
|
||||
*
|
||||
* When instantiating a {@link FormArray}, pass in an array of child controls as the first
|
||||
* argument.
|
||||
|
|
Loading…
Reference in New Issue