From 74b1c7940b3a12131d5ec4a9f6e9168be456c31a Mon Sep 17 00:00:00 2001
From: Hans Kokx <hans.d.kokx@gmail.com>
Date: Fri, 4 Oct 2024 14:29:58 +0200
Subject: [PATCH] Update documentation

Signed-off-by: Hans Kokx <hans.d.kokx@gmail.com>
---
 CHANGELOG.md                   | 13 +++++++++----
 lib/src/extensions/string.dart | 28 ++++++++++++++++++++++++++--
 lib/src/widgets/unfocuser.dart | 33 +++++++++++++++++++++++++++++++++
 pubspec.yaml                   |  2 +-
 4 files changed, 69 insertions(+), 7 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 29a0a21..89e117d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,15 +1,20 @@
+
+## 1.0.3+1
+
+- Updated documentation
+
 ## 1.0.3
 
-* Updated linting rules to use arcane_analysis
+- Updated linting rules to use arcane_analysis
 
 ## 1.0.2
 
-* Added bulletPoint to CommonString
+- Added bulletPoint to CommonString
 
 ## 1.0.1
 
-* Added Unfocuser widget and JSON converters
+- Added Unfocuser widget and JSON converters
 
 ## 1.0.0
 
-* Initial release
+- Initial release
diff --git a/lib/src/extensions/string.dart b/lib/src/extensions/string.dart
index 3cf1532..7102a88 100644
--- a/lib/src/extensions/string.dart
+++ b/lib/src/extensions/string.dart
@@ -10,11 +10,35 @@ abstract class CommonString {
   static const String bulletPoint = "•";
 }
 
+/// An extension that adds convenience methods to handle nullability and
+/// emptiness checks for `String?` types.
 extension Nullability on String? {
-  /// Returns `true` if the `String?` is neither `null` nor only contains whitespace.
+  /// Returns `true` if the `String?` is neither `null` nor contains only whitespace.
+  ///
+  /// This is useful for cases where you want to check if a nullable string has a valid
+  /// non-empty, non-whitespace value.
+  ///
+  /// Example usage:
+  /// ```dart
+  /// String? example = "Hello";
+  /// if (example.isNotNullOrEmpty) {
+  ///   print("The string is not null and not empty");
+  /// }
+  /// ```
   bool get isNotNullOrEmpty => !isNullOrEmpty;
 
-  /// Returns `true` if the `String?` is either `null` or contains only  whitespace.
+  /// Returns `true` if the `String?` is either `null` or contains only whitespace.
+  ///
+  /// This is a handy utility to check if a nullable string is either not assigned
+  /// or effectively empty (including strings with only whitespace characters).
+  ///
+  /// Example usage:
+  /// ```dart
+  /// String? example = null;
+  /// if (example.isNullOrEmpty) {
+  ///   print("The string is null or empty");
+  /// }
+  /// ```
   bool get isNullOrEmpty => this == null || (this ?? "").trim().isEmpty;
 }
 
diff --git a/lib/src/widgets/unfocuser.dart b/lib/src/widgets/unfocuser.dart
index 5ab49f1..6e0a1ab 100644
--- a/lib/src/widgets/unfocuser.dart
+++ b/lib/src/widgets/unfocuser.dart
@@ -26,14 +26,47 @@ THE SOFTWARE.
 
 import "package:flutter/material.dart";
 
+/// A widget that unfocuses the currently focused widget when tapping outside of it.
+///
+/// This is useful for dismissing the keyboard or any focused input field when the user
+/// taps outside of the focused area. The widget wraps its `child` with a `GestureDetector`
+/// that detects taps and unfocuses the primary focus if there is any.
+///
+/// The unfocus behavior can be disabled by setting [isEnabled] to `false`.
+///
+/// Example usage:
+///
+/// ```dart
+/// Unfocuser(
+///   child: YourWidget(),
+/// )
+/// ```
+///
+/// This will unfocus any input fields when the user taps outside of them.
+///
+/// [child] The widget that this widget wraps.
+/// [isEnabled] Whether the unfocus behavior is enabled. Defaults to `true`.
 class Unfocuser extends StatelessWidget {
+  /// Creates an [Unfocuser] widget.
+  ///
+  /// The [child] parameter must not be null. The [isEnabled] parameter determines
+  /// whether the unfocus functionality is active.
   const Unfocuser({
     required this.child,
     super.key,
     this.isEnabled = true,
   });
 
+  /// The widget below this widget in the tree.
+  ///
+  /// This widget will be wrapped with a `GestureDetector` that triggers an
+  /// unfocus action when tapped outside a focused widget, if [isEnabled] is `true`.
   final Widget child;
+
+  /// Whether this widget will trigger the unfocus action.
+  ///
+  /// If set to `true`, tapping outside a focused widget will unfocus it.
+  /// Defaults to `true`.
   final bool isEnabled;
 
   @override
diff --git a/pubspec.yaml b/pubspec.yaml
index 0ad2d10..bb0c6ff 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -1,7 +1,7 @@
 name: arcane_helper_utils
 description: Provides a variety of helpful utilities and extensions for Flutter
   and Dart.
-version: 1.0.3
+version: 1.0.3+1
 repository: https://github.com/hanskokx/arcane_helper_utils
 issue_tracker: https://github.com/hanskokx/arcane_helper_utils/issues