chore: added documentation (#16)

Reviewed-on: #16
Co-authored-by: Ron Rise <ron@siteworxpro.com>
Co-committed-by: Ron Rise <ron@siteworxpro.com>

src/Services/Facade.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Siteworxpro\App\Services;
 
 use Illuminate\Contracts\Container\Container;
+use Illuminate\Support\HigherOrderTapProxy;
 use Illuminate\Support\Testing\Fakes\Fake;
 use Mockery;
 use Mockery\Expectation;
@@ -57,9 +58,9 @@ class Facade
     /**
      * Convert the facade into a Mockery spy.
      *
-     * @return MockInterface
+     * @return HigherOrderTapProxy | MockInterface
      */
-    public static function spy(): MockInterface
+    public static function spy(): HigherOrderTapProxy | MockInterface
     {
         if (! static::isMock()) {
             $class = static::getMockableClass();

src/Services/ServiceProviders/BrokerServiceProvider.php

@@ -8,8 +8,25 @@ use Illuminate\Support\ServiceProvider;
 use Siteworxpro\App\Async\Brokers\Broker;
 use Siteworxpro\App\Services\Facades\Config;
 
+/**
+ * Class BrokerServiceProvider
+ *
+ * This service provider is responsible for binding the Broker implementation
+ * to the Laravel service container based on configuration settings.
+ *
+ * @package Siteworxpro\App\Services\ServiceProviders
+ */
 class BrokerServiceProvider extends ServiceProvider
 {
+    /**
+     * Register services.
+     *
+     * This method binds the Broker interface to a specific implementation
+     * based on the configuration defined in 'queue.broker' and 'queue.broker_config'.
+     *
+     * @return void
+     * @throws \RuntimeException if the specified broker class does not exist.
+     */
     public function register(): void
     {
         $this->app->singleton(Broker::class, function (): Broker {

src/Services/ServiceProviders/DispatcherServiceProvider.php

@@ -7,6 +7,11 @@ namespace Siteworxpro\App\Services\ServiceProviders;
 use Illuminate\Support\ServiceProvider;
 use Siteworxpro\App\Events\Dispatcher;
 
+/**
+ * Class DispatcherServiceProvider
+ *
+ * @package Siteworxpro\App\Services\ServiceProviders
+ */
 class DispatcherServiceProvider extends ServiceProvider
 {
     public function register(): void

src/Services/ServiceProviders/LoggerServiceProvider.php

@@ -7,6 +7,11 @@ namespace Siteworxpro\App\Services\ServiceProviders;
 use Illuminate\Support\ServiceProvider;
 use Siteworxpro\App\Log\Logger;
 
+/**
+ * Class LoggerServiceProvider
+ *
+ * @package Siteworxpro\App\Services\ServiceProviders
+ */
 class LoggerServiceProvider extends ServiceProvider
 {
     public function register(): void

src/Services/ServiceProviders/RedisServiceProvider.php

@@ -8,6 +8,13 @@ use Illuminate\Support\ServiceProvider;
 use Predis\Client;
 use Siteworxpro\App\Services\Facades\Config;
 
+/**
+ * Class RedisServiceProvider
+ *
+ * This service provider registers a Redis client as a singleton in the application container.
+ *
+ * @package Siteworxpro\App\Services\ServiceProviders
+ */
 class RedisServiceProvider extends ServiceProvider
 {
     public function register(): void