Merge pull request #1347 from freemansoft/features/itemDecoration-doc…

…s-update Align comments with style and fix errors in docs
flutter-form-builder-ecosystem · Dec 29, 2023 · 04660f1 · 04660f1
2 parents 7f542eb + a3f193f
commit 04660f1
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 14 deletions.
diff --git a/lib/src/fields/form_builder_checkbox_group.dart b/lib/src/fields/form_builder_checkbox_group.dart
@@ -25,9 +25,8 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderFieldDecoration<List<T>> {
   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
@@ -22,9 +22,8 @@ class FormBuilderRadioGroup<T> extends FormBuilderFieldDecoration<T> {
   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
@@ -181,10 +181,13 @@ class GroupedCheckbox<T> 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
@@ -172,10 +172,13 @@ class GroupedRadio<T> 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({