Skip to content

Commit fd771fc

Browse files
devversionmmalerba
authored andcommitted
docs(radio): fix wrong documentation comment (#12005)
* Fixes that the radio group JSdoc descriptions mention the state of the radio button while the `selected` property is actually about the `MatRadioGroup`
1 parent 9b7d56c commit fd771fc

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

src/lib/radio/radio.ts

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,8 @@ export const _MatRadioGroupMixinBase = mixinDisabled(MatRadioGroupBase);
9090
})
9191
export class MatRadioGroup extends _MatRadioGroupMixinBase
9292
implements AfterContentInit, ControlValueAccessor, CanDisable {
93-
/**
94-
* Selected value for group. Should equal the value of the selected radio button if there *is*
95-
* a corresponding radio button with a matching value. If there is *not* such a corresponding
96-
* radio button, this value persists to be applied in case a new radio button is added with a
97-
* matching value.
98-
*/
93+
94+
/** Selected value for the radio group. */
9995
private _value: any = null;
10096

10197
/** The HTML name attribute applied to radio buttons in this group. */
@@ -154,7 +150,12 @@ export class MatRadioGroup extends _MatRadioGroupMixinBase
154150
this._markRadiosForCheck();
155151
}
156152

157-
/** Value of the radio button. */
153+
/**
154+
* Value for the radio-group. Should equal the value of the selected radio button if there is
155+
* a corresponding radio button with a matching value. If there is not such a corresponding
156+
* radio button, this value persists to be applied in case a new radio button is added with a
157+
* matching value.
158+
*/
158159
@Input()
159160
get value(): any { return this._value; }
160161
set value(newValue: any) {
@@ -173,7 +174,10 @@ export class MatRadioGroup extends _MatRadioGroupMixinBase
173174
}
174175
}
175176

176-
/** Whether the radio button is selected. */
177+
/**
178+
* The currently selected radio button. If set to a new radio button, the radio group value
179+
* will be updated to match the new selected button.
180+
*/
177181
@Input()
178182
get selected() { return this._selected; }
179183
set selected(selected: MatRadioButton | null) {

0 commit comments

Comments
 (0)