From a3f193f9e00db92efd7e9d5a88d6719176e03dde Mon Sep 17 00:00:00 2001 From: Joe Freeman Date: Fri, 29 Dec 2023 09:48:04 -0500 Subject: [PATCH] align comments with style and fix errors in docs --- lib/src/fields/form_builder_checkbox_group.dart | 5 ++--- lib/src/fields/form_builder_radio_group.dart | 5 ++--- lib/src/widgets/grouped_checkbox.dart | 11 +++++++---- lib/src/widgets/grouped_radio.dart | 11 +++++++---- 4 files changed, 18 insertions(+), 14 deletions(-) diff --git a/lib/src/fields/form_builder_checkbox_group.dart b/lib/src/fields/form_builder_checkbox_group.dart index 7bd4c71d1..f5ee8a687 100644 --- a/lib/src/fields/form_builder_checkbox_group.dart +++ b/lib/src/fields/form_builder_checkbox_group.dart @@ -25,9 +25,8 @@ class FormBuilderCheckboxGroup extends FormBuilderFieldDecoration> { final ControlAffinity controlAffinity; final OptionsOrientation orientation; - /// A BoxDecoration that is added to each item if provided - /// WrapSpacing is reused for the the padding inside the itemDecoration - /// on the side opposite from the control + /// Added to each item if provided. + /// [GroupedCheckbox] applies the [itemDecorator] to each Checkbox final BoxDecoration? itemDecoration; /// Creates a list of Checkboxes for selecting multiple options diff --git a/lib/src/fields/form_builder_radio_group.dart b/lib/src/fields/form_builder_radio_group.dart index 0c6acb983..8e08de3e1 100644 --- a/lib/src/fields/form_builder_radio_group.dart +++ b/lib/src/fields/form_builder_radio_group.dart @@ -22,9 +22,8 @@ class FormBuilderRadioGroup extends FormBuilderFieldDecoration { final WrapAlignment wrapRunAlignment; final WrapCrossAlignment wrapCrossAxisAlignment; - /// A BoxDecoration that is added to each item if provided - /// WrapSpacing is reused for the the padding inside the itemDecoration - /// on the side opposite from the control + /// Added to each item if provided. + /// [GroupedRadio] applies the [itemDecorator] to each Radio final BoxDecoration? itemDecoration; /// Creates field to select one value from a list of Radio Widgets diff --git a/lib/src/widgets/grouped_checkbox.dart b/lib/src/widgets/grouped_checkbox.dart index 3b354684f..32f354244 100644 --- a/lib/src/widgets/grouped_checkbox.dart +++ b/lib/src/widgets/grouped_checkbox.dart @@ -181,10 +181,13 @@ class GroupedCheckbox extends StatelessWidget { final ControlAffinity controlAffinity; - /// A BoxDecoration that is added to each item if provided - /// [wrapSpacing] is used as inter-item bottom margin for [Orientation.vertical] - /// [wrapSpacing] is used as inter-item right margin for [Orientation.horizontal]. - /// on the side opposite from the control + /// Applied to a [Container] wrapping each item if provided + /// + /// If the [orientation] is set to [OptionsOrientation.vertical] then + /// [wrapSpacing] is used as inter-item bottom margin + /// + /// If the [orientation] is set to [OptionsOrientation.horizontal] then + /// [wrapSpacing] is used as inter-item right margin final BoxDecoration? itemDecoration; const GroupedCheckbox({ diff --git a/lib/src/widgets/grouped_radio.dart b/lib/src/widgets/grouped_radio.dart index 7e8e365a6..c1ada2cec 100644 --- a/lib/src/widgets/grouped_radio.dart +++ b/lib/src/widgets/grouped_radio.dart @@ -172,10 +172,13 @@ class GroupedRadio extends StatefulWidget { final ControlAffinity controlAffinity; - /// A BoxDecoration that is added to each item if provided - /// [wrapSpacing] is used as inter-item bottom margin for [Orientation.vertical] - /// [wrapSpacing] is used as inter-item right margin for [Orientation.horizontal]. - /// on the side opposite from the control + /// Applied to a [Container] wrapping each item if provided + /// + /// If the [orientation] is set to [OptionsOrientation.vertical] then + /// [wrapSpacing] is used as inter-item bottom margin + /// + /// If the [orientation] is set to [OptionsOrientation.horizontal] then + /// [wrapSpacing] is used as inter-item right margin final BoxDecoration? itemDecoration; const GroupedRadio({