From 9a128a8068bfc302fc4c2eddab1923a818540801 Mon Sep 17 00:00:00 2001 From: Pete Bacon Darwin Date: Fri, 11 Jan 2019 11:16:54 +0000 Subject: [PATCH] docs(forms): fix up `@see` tags for `AbstractContol` (#28069) PR Close #28069 --- packages/forms/src/model.ts | 55 +++++++++++++++++++++++++++---------- 1 file changed, 40 insertions(+), 15 deletions(-) diff --git a/packages/forms/src/model.ts b/packages/forms/src/model.ts index e9d41d74e1..0fb5282f22 100644 --- a/packages/forms/src/model.ts +++ b/packages/forms/src/model.ts @@ -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; @@ -342,9 +345,13 @@ 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. * - * @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. * * `onlySelf`: When true, mark only this control. When false or not supplied, * 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` * 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. * * `onlySelf`: When true, mark only this control. When false or not supplied, * 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 * 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. * * `onlySelf`: When true, mark only this control. When false or not supplied, * marks all direct ancestors. Default is false. @@ -404,7 +419,11 @@ export abstract class AbstractControl { * and recalculates the `pristine` status of all parent * 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. * * `onlySelf`: When true, mark only this control. When false or not supplied, * 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. * - * @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. * * `onlySelf`: When true, mark only this control. When false or not supplied, * 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. * - * @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. * * `onlySelf`: When true, mark only this control. When false or not supplied, * 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. * - * @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 * * `onlySelf`: When true, mark only this control. When false or not supplied, * marks all direct ancestors. Default is false..