feat: add properties documentation

Author: deandreamatias

lib/src/extensions/generic_validator.dart

@@ -1,4 +1,5 @@
 extension GenericValidator<T> on T? {
+  /// Check if the value is empty in a generic way
   bool emptyValidator() {
     if (this == null) return true;
     if (this is Iterable) return (this as Iterable).isEmpty;

lib/src/form_builder_field.dart

@@ -71,12 +71,17 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
   FormBuilderState? _formBuilderState;
   bool _touched = false;
   bool _dirty = false;
+
+  /// The focus node that is used to focus this field.
   late FocusNode effectiveFocusNode;
+
+  /// The focus attachment for the [effectiveFocusNode].
   FocusAttachment? focusAttachment;
 
   @override
   F get widget => super.widget as F;
 
+  /// Returns the parent [FormBuilderState] if it exists.
   FormBuilderState? get formState => _formBuilderState;
 
   /// Returns the initial value, which may be declared at the field, or by the
@@ -91,18 +96,33 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
       widget.valueTransformer == null ? value : widget.valueTransformer!(value);
 
   @override
+
+  /// Returns the current error text,
+  /// which may be a validation error or a custom error text.
   String? get errorText => super.errorText ?? _customErrorText;
 
   @override
+
+  /// Returns `true` if the field has an error or has a custom error text.
   bool get hasError => super.hasError || errorText != null;
 
   @override
+
+  /// Returns `true` if the field is valid and has no custom error text.
   bool get isValid => super.isValid && _customErrorText == null;
 
+  /// Returns `true` if the field is valid.
   bool get valueIsValid => super.isValid;
+
+  /// Returns `true` if the field has an error.
   bool get valueHasError => super.hasError;
 
+  /// Returns `true` if the field is enabled and the parent FormBuilder is enabled.
   bool get enabled => widget.enabled && (_formBuilderState?.enabled ?? true);
+
+  /// Returns `true` if the field is read only.
+  ///
+  /// See [FormBuilder.skipDisabled] for more information.
   bool get readOnly => !(_formBuilderState?.widget.skipDisabled ?? false);
 
   /// Will be true if the field is dirty
@@ -199,6 +219,10 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
   }
 
   @override
+
+  /// Reset field value to initial value
+  ///
+  /// Also reset custom error text if exists, and set [isDirty] to `false`.
   void reset() {
     super.reset();
     didChange(initialValue);
@@ -276,10 +300,12 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
     );
   }
 
+  /// Focus field
   void focus() {
     FocusScope.of(context).requestFocus(effectiveFocusNode);
   }
 
+  /// Scroll to show field
   void ensureScrollableVisibility() {
     Scrollable.ensureVisible(context);
   }

lib/src/form_builder_field_decoration.dart

@@ -35,6 +35,7 @@ class FormBuilderFieldDecorationState<F extends FormBuilderFieldDecoration<T>,
   @override
   F get widget => super.widget as F;
 
+  /// Get the decoration with the current state
   InputDecoration get decoration => widget.decoration.copyWith(
         // Read only allow show error to support property skipDisabled
         errorText: widget.enabled || readOnly

lib/src/form_builder_field_option.dart

@@ -5,7 +5,10 @@ import 'package:flutter/widgets.dart';
 /// The type `T` is the type of the value the entry represents. All the entries
 /// in a given menu must represent values with consistent types.
 class FormBuilderFieldOption<T> extends StatelessWidget {
+  /// The widget to display in list of options.
   final Widget? child;
+
+  /// The value of the option.
   final T value;
 
   /// Creates an option for fields with selection options

lib/src/options/form_builder_chip_option.dart

@@ -6,6 +6,7 @@ import 'package:flutter_form_builder/flutter_form_builder.dart';
 /// The type `T` is the type of the value the entry represents. All the entries
 /// in a given menu must represent values with consistent types.
 class FormBuilderChipOption<T> extends FormBuilderFieldOption<T> {
+  /// The avatar to display in list of options.
   final Widget? avatar;
 
   /// Creates an option for fields with selection options

lib/src/widgets/grouped_checkbox.dart

@@ -23,6 +23,9 @@ class GroupedCheckbox<T> extends StatelessWidget {
   /// The color to use when this checkbox is checked.
   ///
   /// Defaults to [ColorScheme.secondary].
+  ///
+  /// If [fillColor] returns a non-null color in the [WidgetState.selected]
+  /// state, it will be used instead of this color.
   final Color? activeColor;
   final VisualDensity? visualDensity;