Release/1.1.0

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.1.0] - 2024-06-29
+
+### Added
+
+- Update Gradle project to adapt it to the latest version
+- Improved plugin documentation
+- Updated example project 
+
 ## [1.0.0] - 2022-10-31
 
 ### Changed

analysis_options.yaml

@@ -2,4 +2,5 @@ include: package:lint/analysis_options.yaml
 
 linter:
   rules:
-    avoid_classes_with_only_static_members: false
+    avoid_classes_with_only_static_members: false
+    public_member_api_docs: true

example/pubspec.lock

@@ -203,7 +203,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.0.0"
+    version: "1.1.0"
   vector_math:
     dependency: transitive
     description:

lib/exceptions.dart

@@ -1,8 +1,15 @@
 part of 'torch_light.dart';
 
+/// Exception thrown when an attempt was made to turn on the torch but it was
+/// detected that the camera was being used by another process.
+/// This means that the torch cannot be controlled.
 class EnableTorchExistentUserException implements Exception {
+  /// Informative message about this exception.
   String? message;
 
+  /// Exception thrown when an attempt was made to turn on the torch but it was
+  /// detected that the camera was being used by another process.
+  /// This means that the torch cannot be controlled.
   EnableTorchExistentUserException({this.message});
 
   @override
@@ -11,9 +18,14 @@ class EnableTorchExistentUserException implements Exception {
       : "[EnableTorchExistentUserException]";
 }
 
+/// Exception thrown when an error occurred while trying to turn on the
+/// device torch.
 class EnableTorchException implements Exception {
+  /// Informative message about this exception.
   String? message;
 
+  /// Exception thrown when an error occurred while trying to turn on the
+  /// device torch.
   EnableTorchException({this.message});
 
   @override
@@ -22,9 +34,14 @@ class EnableTorchException implements Exception {
       : "[EnableTorchException]";
 }
 
+/// Exception thrown when an attempt was made to turn on the torch but it was
+/// detected that the device does not have one equipped.
 class EnableTorchNotAvailableException implements Exception {
+  /// Informative message about this exception.
   String? message;
 
+  /// Exception thrown when an attempt was made to turn on the torch but it was
+  /// detected that the device does not have one equipped.
   EnableTorchNotAvailableException({this.message});
 
   @override
@@ -33,9 +50,16 @@ class EnableTorchNotAvailableException implements Exception {
       : "[EnableTorchNotAvailableException]";
 }
 
+/// Exception thrown when an attempt was made to turn off the torch but it was
+/// detected that the camera was being used by another process.
+/// This means that the torch cannot be controlled.
 class DisableTorchExistentUserException implements Exception {
+  /// Informative message about this exception.
   String? message;
 
+  /// Exception thrown when an attempt was made to turn off the torch but it was
+  /// detected that the camera was being used by another process.
+  /// This means that the torch cannot be controlled.
   DisableTorchExistentUserException({this.message});
 
   @override
@@ -44,9 +68,14 @@ class DisableTorchExistentUserException implements Exception {
       : "[DisableTorchExistentUserException]";
 }
 
+/// Exception thrown when an error occurred while trying to turn off the
+/// device torch.
 class DisableTorchException implements Exception {
+  /// Informative message about this exception.
   String? message;
 
+  /// Exception thrown when an error occurred while trying to turn off the
+  /// device torch.
   DisableTorchException({this.message});
 
   @override
@@ -55,9 +84,14 @@ class DisableTorchException implements Exception {
       : "[DisableTorchException]";
 }
 
+/// Exception thrown when an attempt was made to turn off the torch but it was
+/// detected that the device does not have one equipped.
 class DisableTorchNotAvailableException implements Exception {
+  /// Informative message about this exception.
   String? message;
 
+  /// Exception thrown when an attempt was made to turn off the torch but it was
+  /// detected that the device does not have one equipped.
   DisableTorchNotAvailableException({this.message});
 
   @override

lib/torch_light.dart

@@ -4,6 +4,8 @@ import 'package:flutter/services.dart';
 
 part 'exceptions.dart';
 
+/// This is the main class of the plugin from which it is possible to check
+/// whether the device has a torch or not, and to turn it on and off.
 class TorchLight {
   // ****************************** CONSTANTS ****************************** //
 
@@ -29,7 +31,7 @@ class TorchLight {
 
   /// Returns true if the device has a torch available, false otherwise.
   ///
-  /// Throws an [EnableTorchException] if the process encounters an error.
+  /// - Throws an [EnableTorchException] if the process encounters an error.
   static Future<bool> isTorchAvailable() async {
     try {
       return await _channel.invokeMethod(_nativeEventIsTorchAvailable) as bool;
@@ -40,9 +42,10 @@ class TorchLight {
 
   /// Enables the device torch.
   ///
-  /// Throws an [EnableTorchExistentUserException] if the camera is being used by another user.
-  /// Throws an [EnableTorchNotAvailableException] if a torch was not detected.
-  /// Throws an [EnableTorchException] if the process encounters an error.
+  /// - Throws an [EnableTorchExistentUserException] if the camera is being used
+  /// by another process.
+  /// - Throws an [EnableTorchNotAvailableException] if a torch was not detected.
+  /// - Throws an [EnableTorchException] if the process encounters an error.
   static Future<void> enableTorch() async {
     try {
       await _channel.invokeMethod(_nativeEventEnableTorch);
@@ -60,9 +63,10 @@ class TorchLight {
 
   /// Disables the device torch.
   ///
-  /// Throws a [DisableTorchExistentUserException] if the camera is being used by another user.
-  /// Throws a [DisableTorchNotAvailableException] if a torch was not detected.
-  /// Throws a [DisableTorchException] if the process encounters an error.
+  /// - Throws a [DisableTorchExistentUserException] if the camera is being used
+  /// by another process.
+  /// - Throws a [DisableTorchNotAvailableException] if a torch was not detected.
+  /// - Throws a [DisableTorchException] if the process encounters an error.
   static Future<void> disableTorch() async {
     try {
       await _channel.invokeMethod(_nativeEventDisableTorch);

pubspec.yaml

@@ -1,7 +1,8 @@
 name: torch_light
-description: A flutter plugin to control the device torch / flashlight.
-version: 1.0.0
-homepage: https://github.com/svprdga/torch_light
+description: A Flutter plugin to check if the device has a torch / flashlight, and to turn it on and off.
+version: 1.1.0
+homepage: https://davidserrano.io/
+repository: https://github.com/svprdga/torch_light
 
 environment:
   sdk: ">=2.17.5 <3.0.0"