Docs

Author: martijn00

lib/src/network/ip_validator.dart

@@ -1,7 +1,21 @@
 import '../../localization/l10n.dart';
 import '../base_validator.dart';
 
+/// {@template ip_validator_template}
+/// [IpValidator] extends [BaseValidator] to validate if a string represents a valid IPv4 or IPv6 address.
+///
+/// This validator checks if the IP address matches the specified regex pattern for either IPv4 or IPv6.
+///
+/// ## Parameters:
+///
+/// - [version] The IP version to validate (either 4 or 6). Defaults to 4.
+/// - [regex] The regular expression used to validate the IP address format. Defaults to standard IPv4 or IPv6 regex.
+/// - [errorText] The error message returned if the validation fails.
+/// - [checkNullOrEmpty] Whether to check if the value is null or empty.
+///
+/// {@endtemplate}
 class IpValidator extends BaseValidator<String> {
+  /// Constructor for the IP address validator.
   IpValidator({
     this.version = 4,
 
@@ -16,8 +30,10 @@ class IpValidator extends BaseValidator<String> {
     super.checkNullOrEmpty,
   });
 
+  /// The IP version to validate (either 4 or 6).
   final int version;
 
+  /// The regular expression used to validate the IP address format.
   final RegExp? regex;
 
   /// {@template ipv4_template}
@@ -54,7 +70,7 @@ class IpValidator extends BaseValidator<String> {
     return !isIP(valueCandidate, version) ? errorText : null;
   }
 
-  /// check if the string [str] is IP [version] 4 or 6
+  /// Check if the string [str] is IP [version] 4 or 6.
   ///
   /// * [version] is a String or an `int`.
   bool isIP(String? str, int version) {

lib/src/network/latitude_validator.dart

@@ -1,9 +1,21 @@
 import '../../localization/l10n.dart';
 import '../base_validator.dart';
 
+/// {@template latitude_validator_template}
+/// [LatitudeValidator] extends [BaseValidator] to validate if a string represents a valid latitude value.
+///
+/// This validator checks if the latitude value is a number within the range of -90 to 90 degrees.
+///
+/// ## Parameters:
+///
+/// - [errorText] The error message returned if the validation fails.
+/// - [checkNullOrEmpty] Whether to check if the value is null or empty.
+///
+/// {@endtemplate}
 class LatitudeValidator extends BaseValidator<String> {
+  /// Constructor for the latitude validator.
   const LatitudeValidator({
-    /// {@macro longitude_validator_error_text}
+    /// {@macro base_validator_error_text}
     super.errorText,
 
     /// {@macro base_validator_null_check}
@@ -12,14 +24,20 @@ class LatitudeValidator extends BaseValidator<String> {
 
   @override
   String get translatedErrorText =>
-      FormBuilderLocalizations.current.longitudeErrorText;
+      FormBuilderLocalizations.current.latitudeErrorText;
 
   @override
   String? validateValue(String valueCandidate) {
     return isLatitude(valueCandidate) ? null : errorText;
   }
 
-  /// check if the string is a valid latitude
+  /// Check if the string is a valid latitude.
+  ///
+  /// ## Parameters:
+  /// - [value] The string to be evaluated.
+  ///
+  /// ## Returns:
+  /// A boolean indicating whether the value is a valid latitude.
   bool isLatitude(String value) {
     final String latitudeValue = value.replaceAll(',', '.');
 

lib/src/network/longitude_validator.dart

@@ -1,9 +1,21 @@
 import '../../localization/l10n.dart';
 import '../base_validator.dart';
 
+/// {@template longitude_validator_template}
+/// [LongitudeValidator] extends [BaseValidator] to validate if a string represents a valid longitude value.
+///
+/// This validator checks if the longitude value is a number within the range of -180 to 180 degrees.
+///
+/// ## Parameters:
+///
+/// - [errorText] The error message returned if the validation fails.
+/// - [checkNullOrEmpty] Whether to check if the value is null or empty.
+///
+/// {@endtemplate}
 class LongitudeValidator extends BaseValidator<String> {
+  /// Constructor for the longitude validator.
   const LongitudeValidator({
-    /// {@macro longitude_validator_error_text}
+    /// {@macro base_validator_error_text}
     super.errorText,
 
     /// {@macro base_validator_null_check}
@@ -19,7 +31,13 @@ class LongitudeValidator extends BaseValidator<String> {
     return isLongitude(valueCandidate) ? null : errorText;
   }
 
-  /// check if the string is a valid longitude
+  /// Check if the string is a valid longitude.
+  ///
+  /// ## Parameters:
+  /// - [value] The string to be evaluated.
+  ///
+  /// ## Returns:
+  /// A boolean indicating whether the value is a valid longitude.
   bool isLongitude(String value) {
     final String longitudeValue = value.replaceAll(',', '.');