Skip to content

Commit a3f193f

Browse files
committed
align comments with style and fix errors in docs
1 parent 7f542eb commit a3f193f

File tree

4 files changed

+18
-14
lines changed

4 files changed

+18
-14
lines changed

lib/src/fields/form_builder_checkbox_group.dart

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderFieldDecoration<List<T>> {
2525
final ControlAffinity controlAffinity;
2626
final OptionsOrientation orientation;
2727

28-
/// A BoxDecoration that is added to each item if provided
29-
/// WrapSpacing is reused for the the padding inside the itemDecoration
30-
/// on the side opposite from the control
28+
/// Added to each item if provided.
29+
/// [GroupedCheckbox] applies the [itemDecorator] to each Checkbox
3130
final BoxDecoration? itemDecoration;
3231

3332
/// Creates a list of Checkboxes for selecting multiple options

lib/src/fields/form_builder_radio_group.dart

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ class FormBuilderRadioGroup<T> extends FormBuilderFieldDecoration<T> {
2222
final WrapAlignment wrapRunAlignment;
2323
final WrapCrossAlignment wrapCrossAxisAlignment;
2424

25-
/// A BoxDecoration that is added to each item if provided
26-
/// WrapSpacing is reused for the the padding inside the itemDecoration
27-
/// on the side opposite from the control
25+
/// Added to each item if provided.
26+
/// [GroupedRadio] applies the [itemDecorator] to each Radio
2827
final BoxDecoration? itemDecoration;
2928

3029
/// Creates field to select one value from a list of Radio Widgets

lib/src/widgets/grouped_checkbox.dart

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,13 @@ class GroupedCheckbox<T> extends StatelessWidget {
181181

182182
final ControlAffinity controlAffinity;
183183

184-
/// A BoxDecoration that is added to each item if provided
185-
/// [wrapSpacing] is used as inter-item bottom margin for [Orientation.vertical]
186-
/// [wrapSpacing] is used as inter-item right margin for [Orientation.horizontal].
187-
/// on the side opposite from the control
184+
/// Applied to a [Container] wrapping each item if provided
185+
///
186+
/// If the [orientation] is set to [OptionsOrientation.vertical] then
187+
/// [wrapSpacing] is used as inter-item bottom margin
188+
///
189+
/// If the [orientation] is set to [OptionsOrientation.horizontal] then
190+
/// [wrapSpacing] is used as inter-item right margin
188191
final BoxDecoration? itemDecoration;
189192

190193
const GroupedCheckbox({

lib/src/widgets/grouped_radio.dart

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,10 +172,13 @@ class GroupedRadio<T> extends StatefulWidget {
172172

173173
final ControlAffinity controlAffinity;
174174

175-
/// A BoxDecoration that is added to each item if provided
176-
/// [wrapSpacing] is used as inter-item bottom margin for [Orientation.vertical]
177-
/// [wrapSpacing] is used as inter-item right margin for [Orientation.horizontal].
178-
/// on the side opposite from the control
175+
/// Applied to a [Container] wrapping each item if provided
176+
///
177+
/// If the [orientation] is set to [OptionsOrientation.vertical] then
178+
/// [wrapSpacing] is used as inter-item bottom margin
179+
///
180+
/// If the [orientation] is set to [OptionsOrientation.horizontal] then
181+
/// [wrapSpacing] is used as inter-item right margin
179182
final BoxDecoration? itemDecoration;
180183

181184
const GroupedRadio({

0 commit comments

Comments
 (0)