chore: added documentation (#16)

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

src/Annotations/Guards/Jwt.php

@@ -7,22 +7,47 @@ namespace Siteworxpro\App\Annotations\Guards;
 use Attribute;
 use Siteworxpro\App\Services\Facades\Config;
 
+/**
+ * Attribute to guard classes or methods with JWT claim requirements.
+ *
+ * Apply this attribute to a class or method to declare the expected JWT issuer and/or audience.
+ * If either the issuer or audience is an empty string, the value will be resolved from configuration:
+ * - `jwt.issuer`
+ * - `jwt.audience`
+ *
+ * Targets: class or method.
+ */
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 readonly class Jwt
 {
+    /**
+     * Initialize the Jwt attribute with optional overrides for expected JWT claims.
+     *
+     * @param string $issuer   Optional expected JWT issuer (`iss`). Empty string uses `Config::get('jwt.issuer')`.
+     * @param string $audience Optional expected JWT audience (`aud`). Empty string uses `Config::get('jwt.audience')`.
+     */
     public function __construct(
         private string $issuer = '',
         private string $audience = '',
     ) {
     }
 
+    /**
+     * Get the required audience from configuration, ignoring any local override.
+     *
+     * @return string The globally configured audience or an empty string if not set.
+     */
     public function getRequiredAudience(): string
     {
         return Config::get('jwt.audience') ?? '';
     }
 
     /**
-     * @return string
+     * Get the expected audience for validation.
+     *
+     * Returns the constructor-provided audience when non-empty; otherwise falls back to `jwt.audience` config.
+     *
+     * @return string The audience value to enforce.
      */
     public function getAudience(): string
     {
@@ -33,6 +58,13 @@ readonly class Jwt
         return $this->audience;
     }
 
+    /**
+     * Get the expected issuer for validation.
+     *
+     * Returns the constructor-provided issuer when non-empty; otherwise falls back to `jwt.issuer` config.
+     *
+     * @return string The issuer value to enforce.
+     */
     public function getIssuer(): string
     {
         if ($this->issuer === '') {
@@ -41,4 +73,4 @@ readonly class Jwt
 
         return $this->issuer;
     }
-}
+}