iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(forms): fix up `@see` tags for `AbstractContol` (#28069) 

PR Close #28069
This commit is contained in:
Pete Bacon Darwin 2019-01-11 11:16:54 +00:00 committed by Andrew Kushnir
parent cd51775390
commit 9a128a8068
1 changed files with 40 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
packages/forms/src/model.ts
View File

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