Docs

Author: martijn00

example/lib/home_page.dart

@@ -1,7 +1,9 @@
 import 'package:flutter/material.dart';
 import 'package:form_builder_validators/form_builder_validators.dart';
 
+/// Represents the home page of the application.
 class HomePage extends StatelessWidget {
+  /// Constructs a new instance of the [HomePage] class.
   const HomePage({super.key});
 
   @override

example/lib/override_form_builder_localizations_en.dart

@@ -3,14 +3,18 @@ import 'package:flutter/material.dart';
 import 'package:form_builder_validators/form_builder_validators.dart';
 
 /// Created by ipcjs on 2022/10/31.
+///
+/// Overrides the default FormBuilderLocalizationsImplEn class for English localizations.
 class OverrideFormBuilderLocalizationsEn
     extends FormBuilderLocalizationsImplEn {
   /// Constructor for the override class.
   OverrideFormBuilderLocalizationsEn();
 
+  /// The delegate for the override class.
   static const LocalizationsDelegate<FormBuilderLocalizationsImpl> delegate =
       _LocalizationsDelegate();
 
+  /// The list of supported locales for the override class.
   static const List<Locale> supportedLocales = <Locale>[Locale('en')];
 
   // Override a field and return your translation.

lib/src/bool/has_lowercase_chars_validator.dart

@@ -1,7 +1,20 @@
 import '../../localization/l10n.dart';
 import '../base_validator.dart';
 
+/// {@template has_lowercase_chars_template}
+/// [HasLowercaseCharsValidator] extends [BaseValidator] to validate if a string
+/// contains a specified minimum number of lowercase characters.
+///
+/// ## Parameters:
+///
+/// - [atLeast] The minimum number of lowercase characters required.
+/// - [regex] The regular expression used to identify lowercase characters.
+/// - [errorText] The error message returned if the validation fails.
+///
+/// {@macro lower_case_template}
+/// {@endtemplate}
 class HasLowercaseCharsValidator extends BaseValidator<String> {
+  /// Constructor for the lowercase characters validator.
   HasLowercaseCharsValidator({
     this.atLeast = 1,
 
@@ -15,21 +28,23 @@ class HasLowercaseCharsValidator extends BaseValidator<String> {
     super.checkNullOrEmpty,
   }) : regex = regex ?? _lowerCase;
 
+  /// The minimum number of lowercase characters required.
   final int atLeast;
 
+  /// The regular expression used to identify lowercase characters.
   final RegExp regex;
 
   @override
   String get translatedErrorText =>
       FormBuilderLocalizations.current.containsLowercaseCharErrorText(atLeast);
 
   /// {@template lower_case_template}
-  /// This regex matches any character that is not a lowercase letter (a-z).
+  /// This regex matches any character that is a lowercase letter (a-z).
   ///
-  /// - It includes special characters, digits, and uppercase letters.
-  /// - It can be used to find non-lowercase characters.
+  /// - It includes all lowercase letters.
+  /// - It can be used to find lowercase characters.
   ///
-  /// Examples: A, 1, @
+  /// Examples: a, b, c
   /// {@endtemplate}
   static final RegExp _lowerCase = RegExp('[a-z]');
 
@@ -38,6 +53,13 @@ class HasLowercaseCharsValidator extends BaseValidator<String> {
     return lowercaseCharLength(valueCandidate) >= atLeast ? null : errorText;
   }
 
+  /// Calculates the number of lowercase characters in the given value.
+  ///
+  /// ## Parameters:
+  /// - [value] The string to be evaluated.
+  ///
+  /// ## Returns:
+  /// The count of lowercase characters in the string.
   int lowercaseCharLength(String value) {
     return regex.allMatches(value).length;
   }

lib/src/bool/has_numeric_chars_validator.dart

@@ -1,7 +1,20 @@
 import '../../localization/l10n.dart';
 import '../base_validator.dart';
 
+/// {@template has_numeric_chars_template}
+/// [HasNumericCharsValidator] extends [BaseValidator] to validate if a string
+/// contains a specified minimum number of numeric characters (digits).
+///
+/// ## Parameters:
+///
+/// - [atLeast] The minimum number of numeric characters required.
+/// - [regex] The regular expression used to identify numeric characters.
+/// - [errorText] The error message returned if the validation fails.
+///
+/// {@macro numeric_chars_template}
+/// {@endtemplate}
 class HasNumericCharsValidator extends BaseValidator<String> {
+  /// Constructor for the numeric characters validator.
   HasNumericCharsValidator({
     this.atLeast = 1,
 
@@ -15,21 +28,23 @@ class HasNumericCharsValidator extends BaseValidator<String> {
     super.checkNullOrEmpty,
   }) : regex = regex ?? _number;
 
+  /// The minimum number of numeric characters required.
   final int atLeast;
 
+  /// The regular expression used to identify numeric characters.
   final RegExp regex;
 
   @override
   String get translatedErrorText =>
       FormBuilderLocalizations.current.containsNumberErrorText(atLeast);
 
   /// {@template numeric_chars_template}
-  /// This regex matches any character that is not a digit (0-9).
+  /// This regex matches any character that is a digit (0-9).
   ///
-  /// - It includes special characters, letters, and other non-numeric characters.
-  /// - It can be used to find non-digit characters.
+  /// - It includes all numeric digits.
+  /// - It can be used to find numeric characters.
   ///
-  /// Examples: a, A, @
+  /// Examples: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
   /// {@endtemplate}
   static final RegExp _number = RegExp('[0-9]');
 
@@ -38,6 +53,13 @@ class HasNumericCharsValidator extends BaseValidator<String> {
     return numberCharLength(valueCandidate) >= atLeast ? null : errorText;
   }
 
+  /// Calculates the number of numeric characters in the given value.
+  ///
+  /// ## Parameters:
+  /// - [value] The string to be evaluated.
+  ///
+  /// ## Returns:
+  /// The count of numeric characters in the string.
   int numberCharLength(String value) {
     return regex.allMatches(value).length;
   }

lib/src/network/email_validator.dart

@@ -2,17 +2,18 @@ import '../../localization/l10n.dart';
 import '../base_validator.dart';
 
 /// {@template email_template}
-/// `EmailValidator` extends `BaseValidator` that validates a given email address.
+/// [EmailValidator] extends [BaseValidator] that validates a given email address.
 /// It uses a regular expression to check if the email address is valid.
 ///
-/// Parameters:
+/// ## Parameters:
 ///
-/// - [errorText]: The error message returned if the email address is invalid.
-/// - [regex]: The regular expression used to validate the email address.
+/// - [errorText] The error message returned if the email address is invalid.
+/// - [regex] The regular expression used to validate the email address.
 ///
 /// {@macro email_regex_template}
 /// {@endtemplate}
 class EmailValidator extends BaseValidator<String> {
+  /// Constructor for the email validator.
   EmailValidator({
     /// {@macro email_regex_template}
     RegExp? regex,
@@ -28,6 +29,9 @@ class EmailValidator extends BaseValidator<String> {
   String get translatedErrorText =>
       FormBuilderLocalizations.current.emailErrorText;
 
+  /// The regular expression used to validate the email address.
+  final RegExp regex;
+
   /// {@template email_regex_template}
   /// The default regex matches an email address.
   ///
@@ -41,9 +45,6 @@ class EmailValidator extends BaseValidator<String> {
     r"^((([a-z]|\d|[!#\$%&'*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))$",
   );
 
-  /// The regular expression used to validate the email address.
-  final RegExp regex;
-
   @override
   String? validateValue(String valueCandidate) {
     return regex.hasMatch(valueCandidate.toLowerCase()) ? null : errorText;