cargdev/angular
1
0
Fork 0
Code Issues 18 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(forms): remove unnecessary {@link Injector} jsdoc tags (#23186)

Browse Source 
Inline code blocks are automatically linked, if possible, to their API
page.

PR Close #23186
This commit is contained in:
Pete Bacon Darwin
2018-04-05 10:58:12 +01:00
committed by Igor Minar
parent 1aef4df127
commit 92821e338b
23 changed files with 136 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -83,7 +83,7 @@ export type FormHooks = 'change' | 'blur' | 'submit';
/**
* @description
*
* Interface for options provided to an {@link AbstractControl}.
* Interface for options provided to an `AbstractControl`.
*
* @experimental
*/
@ -113,7 +113,7 @@ function isOptionsObj(
/**
* @description
*
* This is the base class for {@link FormControl}, {@link FormGroup}, and {@link FormArray}.
* This is the base class for `FormControl`, `FormGroup`, and `FormArray`.
*
* It provides some of the shared behavior that all controls and groups of controls have, like
* running validators, calculating status, and resetting state. It also defines the properties
@ -676,9 +676,9 @@ export abstract class AbstractControl {
* Tracks the value and validation status of an individual form control.
*
* This is one of the three fundamental building blocks of Angular forms, along with
* {@link FormGroup} and {@link FormArray}.
* `FormGroup` and `FormArray`.
*
* When instantiating a {@link FormControl}, you can pass in an initial value as the
* When instantiating a `FormControl`, you can pass in an initial value as the
* first argument. Example:
*
* ```ts
@ -697,7 +697,7 @@ export abstract class AbstractControl {
* console.log(ctrl.status); // 'DISABLED'
* ```
*
* The second {@link FormControl} argument can accept one of three things:
* The second `FormControl` argument can accept one of three things:
* * a sync validator function
* * an array of sync validator functions
* * an options object containing validator and/or async validator functions
@ -731,7 +731,7 @@ export abstract class AbstractControl {
* You can also set `updateOn` to `'submit'`, which will delay value and validity
* updates until the parent form of the control fires a submit event.
*
* See its superclass, {@link AbstractControl}, for more properties and methods.
* See its superclass, `AbstractControl`, for more properties and methods.
*
* * **npm package**: `@angular/forms`
*
@ -911,17 +911,17 @@ export class FormControl extends AbstractControl {
/**
* @description
*
* Tracks the value and validity state of a group of {@link FormControl} instances.
* Tracks the value and validity state of a group of `FormControl` instances.
*
* A `FormGroup` aggregates the values of each child {@link FormControl} into one object,
* A `FormGroup` aggregates the values of each child `FormControl` into one object,
* with each control name as the key. It calculates its status by reducing the statuses
* of its children. For example, if one of the controls in a group is invalid, the entire
* group becomes invalid.
*
* `FormGroup` is one of the three fundamental building blocks used to define forms in Angular,
* along with {@link FormControl} and {@link FormArray}.
* along with `FormControl` and `FormArray`.
*
* When instantiating a {@link FormGroup}, pass in a collection of child controls as the first
* When instantiating a `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.
*
* ### Example
@ -955,7 +955,7 @@ export class FormControl extends AbstractControl {
* }
* ```
*
* Like {@link FormControl} instances, you can alternatively choose to pass in
* Like `FormControl` instances, you can alternatively choose to pass in
* validators and async validators as part of an options object.
*
* ```
@ -1049,7 +1049,7 @@ export class FormGroup extends AbstractControl {
}
/**
* Sets the value of the {@link FormGroup}. It accepts an object that matches
* Sets the value of the `FormGroup`. It accepts an object that matches
* the structure of the group, with control names as keys.
*
* ### Example
@ -1080,7 +1080,7 @@ export class FormGroup extends AbstractControl {
}
/**
* Patches the value of the {@link FormGroup}. It accepts an object with control
* Patches the value of the `FormGroup`. It accepts an object with control
* names as keys, and will do its best to match the values to the correct controls
* in the group.
*
@ -1111,7 +1111,7 @@ export class FormGroup extends AbstractControl {
}
/**
* Resets the {@link FormGroup}. This means by default:
* Resets the `FormGroup`. This means by default:
*
* * The group and all descendants are marked `pristine`
* * The group and all descendants are marked `untouched`
@ -1152,7 +1152,7 @@ export class FormGroup extends AbstractControl {
}
/**
* The aggregate value of the {@link FormGroup}, including any disabled controls.
* The aggregate value of the `FormGroup`, including any disabled controls.
*
* If you'd like to include all values regardless of disabled status, use this method.
* Otherwise, the `value` property is the best way to get the value of the group.
@ -1254,17 +1254,17 @@ export class FormGroup extends AbstractControl {
/**
* @description
*
* Tracks the value and validity state of an array of {@link FormControl},
* {@link FormGroup} or {@link FormArray} instances.
* Tracks the value and validity state of an array of `FormControl`,
* `FormGroup` or `FormArray` instances.
*
* A `FormArray` aggregates the values of each child {@link FormControl} into an array.
* A `FormArray` aggregates the values of each child `FormControl` into an array.
* It calculates its status by reducing the statuses of its children. For example, if one of
* the controls in a `FormArray` is invalid, the entire array becomes invalid.
*
* `FormArray` is one of the three fundamental building blocks used to define forms in Angular,
* along with {@link FormControl} and {@link FormGroup}.
* along with `FormControl` and `FormGroup`.
*
* When instantiating a {@link FormArray}, pass in an array of child controls as the first
* When instantiating a `FormArray`, pass in an array of child controls as the first
* argument.
*
* ### Example
@ -1331,12 +1331,12 @@ export class FormArray extends AbstractControl {
}
/**
* Get the {@link AbstractControl} at the given `index` in the array.
* Get the `AbstractControl` at the given `index` in the array.
*/
at(index: number): AbstractControl { return this.controls[index]; }
/**
* Insert a new {@link AbstractControl} at the end of the array.
* Insert a new `AbstractControl` at the end of the array.
*/
push(control: AbstractControl): void {
this.controls.push(control);
@ -1345,7 +1345,7 @@ export class FormArray extends AbstractControl {
this._onCollectionChange();
}
/** Insert a new {@link AbstractControl} at the given `index` in the array. */
/** Insert a new `AbstractControl` at the given `index` in the array. */
insert(index: number, control: AbstractControl): void {
this.controls.splice(index, 0, control);
@ -1382,7 +1382,7 @@ export class FormArray extends AbstractControl {
get length(): number { return this.controls.length; }
/**
* Sets the value of the {@link FormArray}. It accepts an array that matches
* Sets the value of the `FormArray`. It accepts an array that matches
* the structure of the control.
*
* This method performs strict checks, so it will throw an error if you try
@ -1412,7 +1412,7 @@ export class FormArray extends AbstractControl {
}
/**
* Patches the value of the {@link FormArray}. It accepts an array that matches the
* Patches the value of the `FormArray`. It accepts an array that matches the
* structure of the control, and will do its best to match the values to the correct
* controls in the group.
*
@ -1441,7 +1441,7 @@ export class FormArray extends AbstractControl {
}
/**
* Resets the {@link FormArray}. This means by default:
* Resets the `FormArray`. This means by default:
*
* * The array and all descendants are marked `pristine`
* * The array and all descendants are marked `untouched`