docs(forms): fix up `@see` tags for `AbstractContol` (#28069)
PR Close #28069
This commit is contained in:
parent
cd51775390
commit
9a128a8068
|
@ -198,7 +198,7 @@ export abstract class AbstractControl {
|
|||
/**
|
||||
* A control is `valid` when its `status` is `VALID`.
|
||||
*
|
||||
* @see `status`
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
* @returns True if the control has passed all of its validation tests,
|
||||
* false otherwise.
|
||||
|
@ -208,7 +208,7 @@ export abstract class AbstractControl {
|
|||
/**
|
||||
* A control is `invalid` when its `status` is `INVALID`.
|
||||
*
|
||||
* @see `status`
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
* @returns True if this control has failed one or more of its validation checks,
|
||||
* false otherwise.
|
||||
|
@ -218,7 +218,7 @@ export abstract class AbstractControl {
|
|||
/**
|
||||
* A control is `pending` when its `status` is `PENDING`.
|
||||
*
|
||||
* @see `status`
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
* @returns True if this control is in the process of conducting a validation check,
|
||||
* false otherwise.
|
||||
|
@ -228,12 +228,12 @@ export abstract class AbstractControl {
|
|||
/**
|
||||
* A control is `disabled` when its `status` is `DISABLED`.
|
||||
*
|
||||
* @see `status`
|
||||
*
|
||||
* Disabled controls are exempt from validation checks and
|
||||
* are not included in the aggregate value of their ancestor
|
||||
* controls.
|
||||
*
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
* @returns True if the control is disabled, false otherwise.
|
||||
*/
|
||||
get disabled(): boolean { return this.status === DISABLED; }
|
||||
|
@ -241,11 +241,11 @@ export abstract class AbstractControl {
|
|||
/**
|
||||
* A control is `enabled` as long as its `status` is not `DISABLED`.
|
||||
*
|
||||
* @see `status`
|
||||
*
|
||||
* @returns True if the control has any status other than 'DISABLED',
|
||||
* false if the status is 'DISABLED'.
|
||||
*
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
*/
|
||||
get enabled(): boolean { return this.status !== DISABLED; }
|
||||
|
||||
|
@ -300,6 +300,9 @@ export abstract class AbstractControl {
|
|||
/**
|
||||
* A multicasting observable that emits an event every time the validation `status` of the control
|
||||
* recalculates.
|
||||
*
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
*/
|
||||
// TODO(issue/24571): remove '!'.
|
||||
public readonly statusChanges !: Observable<any>;
|
||||
|
@ -342,7 +345,11 @@ export abstract class AbstractControl {
|
|||
|
||||
/**
|
||||
* Marks the control as `touched`. A control is touched by focus and
|
||||
* blur events that do not change the value; compare `markAsDirty`;
|
||||
* blur events that do not change the value.
|
||||
*
|
||||
* @see `markAsUntouched()`
|
||||
* @see `markAsDirty()`
|
||||
* @see `markAsPristine()`
|
||||
*
|
||||
* @param opts Configuration options that determine how the control propagates changes
|
||||
* and emits events events after marking is applied.
|
||||
|
@ -363,6 +370,10 @@ export abstract class AbstractControl {
|
|||
* If the control has any children, also marks all children as `untouched`
|
||||
* and recalculates the `touched` status of all parent controls.
|
||||
*
|
||||
* @see `markAsTouched()`
|
||||
* @see `markAsDirty()`
|
||||
* @see `markAsPristine()`
|
||||
*
|
||||
* @param opts Configuration options that determine how the control propagates changes
|
||||
* and emits events after the marking is applied.
|
||||
* * `onlySelf`: When true, mark only this control. When false or not supplied,
|
||||
|
@ -384,6 +395,10 @@ export abstract class AbstractControl {
|
|||
* Marks the control as `dirty`. A control becomes dirty when
|
||||
* the control's value is changed through the UI; compare `markAsTouched`.
|
||||
*
|
||||
* @see `markAsTouched()`
|
||||
* @see `markAsUntouched()`
|
||||
* @see `markAsPristine()`
|
||||
*
|
||||
* @param opts Configuration options that determine how the control propagates changes
|
||||
* and emits events after marking is applied.
|
||||
* * `onlySelf`: When true, mark only this control. When false or not supplied,
|
||||
|
@ -404,6 +419,10 @@ export abstract class AbstractControl {
|
|||
* and recalculates the `pristine` status of all parent
|
||||
* controls.
|
||||
*
|
||||
* @see `markAsTouched()`
|
||||
* @see `markAsUntouched()`
|
||||
* @see `markAsDirty()`
|
||||
*
|
||||
* @param opts Configuration options that determine how the control emits events after
|
||||
* marking is applied.
|
||||
* * `onlySelf`: When true, mark only this control. When false or not supplied,
|
||||
|
@ -425,6 +444,8 @@ export abstract class AbstractControl {
|
|||
*
|
||||
* A control is pending while the control performs async validation.
|
||||
*
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
* @param opts Configuration options that determine how the control propagates changes and
|
||||
* emits events after marking is applied.
|
||||
* * `onlySelf`: When true, mark only this control. When false or not supplied,
|
||||
|
@ -452,6 +473,8 @@ export abstract class AbstractControl {
|
|||
*
|
||||
* If the control has children, all children are also disabled.
|
||||
*
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
* @param opts Configuration options that determine how the control propagates
|
||||
* changes and emits events after the control is disabled.
|
||||
* * `onlySelf`: When true, mark only this control. When false or not supplied,
|
||||
|
@ -484,6 +507,8 @@ export abstract class AbstractControl {
|
|||
*
|
||||
* By default, if the control has children, all children are enabled.
|
||||
*
|
||||
* @see {@link AbstractControl.status}
|
||||
*
|
||||
* @param opts Configure options that control how the control propagates changes and
|
||||
* emits events when marked as untouched
|
||||
* * `onlySelf`: When true, mark only this control. When false or not supplied,
|
||||
|
|
Loading…
Reference in New Issue