Skip to content

Commit 984f8dc

Browse files
crisbetommalerba
authored andcommitted
chore: add docs to undocumented form field symbols (#11435)
Adds doc strings to some symbols that are part of the form field public API. Fixes #11429.
1 parent fb5cdb2 commit 984f8dc

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

src/lib/form-field/form-field.ts

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,23 +56,35 @@ const floatingLabelScale = 0.75;
5656
const outlineGapPadding = 5;
5757

5858

59-
// Boilerplate for applying mixins to MatFormField.
60-
/** @docs-private */
59+
/**
60+
* Boilerplate for applying mixins to MatFormField.
61+
* @docs-private
62+
*/
6163
export class MatFormFieldBase {
6264
constructor(public _elementRef: ElementRef) { }
6365
}
6466

65-
67+
/**
68+
* Base class to which we're applying the form field mixins.
69+
* @docs-private
70+
*/
6671
export const _MatFormFieldMixinBase = mixinColor(MatFormFieldBase, 'primary');
6772

68-
73+
/** Possible appearance styles for the form field. */
6974
export type MatFormFieldAppearance = 'legacy' | 'standard' | 'fill' | 'outline';
7075

71-
76+
/**
77+
* Represents the default options form the form field that can be configured
78+
* using the `MAT_FORM_FIELD_DEFAULT_OPTIONS` injection token.
79+
*/
7280
export interface MatFormFieldDefaultOptions {
7381
appearance?: MatFormFieldAppearance;
7482
}
7583

84+
/**
85+
* Injection token that can be used to configure the
86+
* default options for all form field within an app.
87+
*/
7688
export const MAT_FORM_FIELD_DEFAULT_OPTIONS =
7789
new InjectionToken<MatFormFieldDefaultOptions>('MAT_FORM_FIELD_DEFAULT_OPTIONS');
7890

0 commit comments

Comments
 (0)