Update Doc Comments to Maintain Doppar Comment Convention (#164)

Author: techmahedy

src/Phaseolies/Session/Handlers/CookieSessionHandler.php

@@ -90,9 +90,9 @@ public function validate(): void
     /**
      * Called when a session is opened.
      *
-     * @param string $savePath The path where session data is stored (not used in cookie handler).
-     * @param string $sessionName The name of the session (not used in cookie handler).
-     * @return bool Always returns true, indicating success.
+     * @param string $savePath
+     * @param string $sessionName
+     * @return bool
      */
     public function open($savePath, $sessionName): bool
     {
@@ -102,7 +102,7 @@ public function open($savePath, $sessionName): bool
     /**
      * Called when a session is closed.
      *
-     * @return bool Always returns true, indicating success.
+     * @return bool
      */
     public function close(): bool
     {
@@ -112,8 +112,8 @@ public function close(): bool
     /**
      * Reads session data from the cookie, decrypting it.
      *
-     * @param string $sessionId The ID of the session to read (not directly used as data is in cookie).
-     * @return string The decrypted session data, or an empty string if not found or invalid.
+     * @param string $sessionId
+     * @return string
      */
     public function read($sessionId): string
     {
@@ -137,9 +137,9 @@ public function read($sessionId): string
     /**
      * Writes session data to the cookie, encrypting it.
      *
-     * @param string $sessionId The ID of the session to write (not directly used as data is in cookie).
-     * @param string $sessionData The raw session data string to be written.
-     * @return bool True on successful write, false otherwise (e.g., if `setcookie` fails).
+     * @param string $sessionId
+     * @param string $sessionData
+     * @return bool
      */
     public function write($sessionId, $sessionData): bool
     {
@@ -179,8 +179,8 @@ public function write($sessionId, $sessionData): bool
     /**
      * Destroys the session data by invalidating the session cookie.
      *
-     * @param string $sessionId The ID of the session to destroy (not directly used).
-     * @return bool True on successful destruction, false if headers have already been sent.
+     * @param string $sessionId
+     * @return bool
      */
     public function destroy($sessionId): bool
     {
@@ -190,8 +190,8 @@ public function destroy($sessionId): bool
     /**
      * Performs garbage collection for session data.
      *
-     * @param int $maxlifetime The maximum lifetime of a session (not used for cookie handler).
-     * @return bool Always returns true.
+     * @param int $maxlifetime
+     * @return bool
      */
     public function gc($maxlifetime): bool
     {
@@ -201,7 +201,7 @@ public function gc($maxlifetime): bool
     /**
      * Destroys the session cookie by setting its expiration to a past time.
      *
-     * @return bool True on successful cookie destruction, false if headers have already been sent.
+     * @return bool
      */
     private function destroyCookie(): bool
     {
@@ -225,9 +225,9 @@ private function destroyCookie(): bool
     /**
      * Encrypts the given data using AES-256-CBC encryption.
      *
-     * @param string $data The plain text data to encrypt.
-     * @return string The base64-encoded string containing the IV and encrypted data.
-     * @throws RuntimeException If the application key is not set or encryption fails.
+     * @param string $data
+     * @return string
+     * @throws RuntimeException
      */
     private function encrypt(string $data): string
     {
@@ -241,9 +241,9 @@ private function encrypt(string $data): string
     /**
      * Decrypts the given base64-encoded encrypted data using AES-256-CBC decryption.
      *
-     * @param string $data The base64-encoded string containing the IV and encrypted data.
-     * @return string The decrypted plain text data.
-     * @throws RuntimeException If the application key is not set, data is malformed, or decryption fails.
+     * @param string $data
+     * @return string
+     * @throws RuntimeException
      */
     private function decrypt(string $data): string
     {

src/Phaseolies/Support/Collection.php

@@ -36,8 +36,8 @@ public function __construct(string $model, ?array $data = [])
     /**
      * Access collection data properties directly.
      *
-     * @param string $name The property name to access
-     * @return mixed|null The value if exists, null otherwise
+     * @param string $name
+     * @return mixed|null
      */
     public function __get($name)
     {
@@ -93,8 +93,8 @@ public function __call($method, $parameters)
     /**
      * Check if a property exists in the collection data
      *
-     * @param string $name The property name to check
-     * @return bool True if property exists, false otherwise
+     * @param string $name
+     * @return bool
      */
     public function __isset($name)
     {
@@ -265,7 +265,7 @@ public function push(mixed $item): self
     /**
      * Flatten a multi-dimensional collection into a single level.
      *
-     * @param int $depth The maximum depth to flatten (default: infinite)
+     * @param int $depth
      * @return static
      */
     public function flatten(int $depth = PHP_INT_MAX): self
@@ -322,8 +322,8 @@ public function values(): self
     /**
      * Return a new collection with unique items.
      *
-     * @param string|null $key Optional key to use for determining uniqueness
-     * @param bool $strict Whether to use strict comparison (===)
+     * @param string|null $key
+     * @param bool $strict
      * @return static
      */
     public function unique(?string $key = null, bool $strict = false): self
@@ -350,8 +350,8 @@ public function unique(?string $key = null, bool $strict = false): self
     /**
      * Pluck an array of values from a given key.
      *
-     * @param string $value The key to pluck values from
-     * @param string|null $key Optional key to use as array keys in the result
+     * @param string $value
+     * @param string|null $key
      * @return static
      */
     public function pluck(string $value, ?string $key = null): self
@@ -400,7 +400,7 @@ public function isNotEmpty(): bool
     /**
      * Output or return memory usage stats related to the current collection.
      *
-     * @param bool $asString If true, returns human-readable string. Otherwise, returns an array.
+     * @param bool $asString
      * @return string|array
      */
     public function withMemoryUsage(bool $asString = true): string|array
@@ -429,8 +429,8 @@ public function withMemoryUsage(bool $asString = true): string|array
     /**
      * Map the collection and group the results by the given key.
      *
-     * @param callable|string $groupBy Key to group by or callback that returns the group key
-     * @param callable|null $mapCallback Callback to transform each item (optional)
+     * @param callable|string $groupBy
+     * @param callable|null $mapCallback
      * @return array
      */
     public function mapAsGroup($groupBy, ?callable $mapCallback = null): array
@@ -456,8 +456,8 @@ public function mapAsGroup($groupBy, ?callable $mapCallback = null): array
     /**
      * Map the collection and use the given key as array keys.
      *
-     * @param callable|string $keyBy Key to use as array key or callback that returns the key
-     * @param callable|null $mapCallback Callback to transform each item (optional)
+     * @param callable|string $keyBy
+     * @param callable|null $mapCallback
      * @return array
      */
     public function mapAsKey($keyBy, ?callable $mapCallback = null): array
@@ -572,7 +572,7 @@ public function mapWithKeys(callable $callback): array
     /**
      * Convert the collection to JSON.
      *
-     * @param int $options JSON encoding options
+     * @param int $options
      * @return string
      */
     public function toJson(int $options = 0): string

src/Phaseolies/Support/CookieJar.php

@@ -175,7 +175,7 @@ protected function setCookie(Cookie $cookie): bool
     /**
      * Get all cookies that were sent with the current request
      *
-     * @param bool $decodeValues Whether to URL-decode cookie values (default: true)
+     * @param bool $decodeValues
      * @return array
      */
     public function all(bool $decodeValues = true): array

src/Phaseolies/Support/File.php

@@ -24,7 +24,7 @@ class File extends \SplFileInfo
     /**
      * Constructor that initializes the File object with the given file data.
      *
-     * @param array $file The uploaded file's data from the $_FILES array.
+     * @param array $file
      */
     public function __construct(\SplFileInfo|string|array $file, bool $checkPath = true)
     {
@@ -131,7 +131,7 @@ public function generateUniqueName(): string
     /**
      * Checks if the uploaded file is of a specific MIME type.
      *
-     * @param string|array $mimeType The MIME type(s) to check against.
+     * @param string|array $mimeType
      * @return bool
      */
     public function isMimeType(string|array $mimeType): bool
@@ -190,8 +190,8 @@ public function isDocument(): bool
     /**
      * Moves the uploaded file to a new location.
      *
-     * @param string $destination The destination path to move the file to.
-     * @param string|null $fileName Optional filename to use. If null, the original filename is used.
+     * @param string $destination
+     * @param string|null $fileName
      * @return bool
      */
     public function move(string $destination, ?string $fileName = null): bool
@@ -267,10 +267,10 @@ public function store(string $path, string $disk = 'public'): bool
     /**
      * Store the file with filename
      *
-     * @param string $path The directory path to store the file
-     * @param string $fileName The filename to use
-     * @param string $disk The storage disk to use (default: 'public')
-     * @param callable|null $callback Optional validation callback
+     * @param string $path
+     * @param string $fileName
+     * @param string $disk
+     * @param callable|null $callback
      * @return string|false
      */
     public function storeAs(string $path, string $fileName = '', string $disk = 'public', ?callable $callback = null): string|false

src/Phaseolies/Support/Lens.php

@@ -8,13 +8,6 @@
 /**
  * Static proxy class for array manipulation operations.
  *
- * Provides a fluent, static interface to the RealLens implementation while handling
- * reference parameters properly. This class serves as a facade that:
- *
- * 1. Manages a singleton instance of RealLens
- * 2. Proxies method calls to the implementation
- * 3. Special-cases reference-based methods (put/zap)
- *
  * @method mixed grab(array $array, string|int|null $key, mixed $default = null) Get array value using dot notation
  * @method array put(array &$array, string $key, mixed $value) Set array value using dot notation (modifies by reference)
  * @method bool got(array $array, string|array $keys) Check if key(s) exist in array
@@ -62,12 +55,8 @@ private static function make(): Lensable
     /**
      * Handle static method calls
      *
-     * Proxies calls to the implementation instance with special handling for:
-     * - put(): Modifies array by reference
-     * - zap(): Modifies array by reference
-     *
-     * @param string $method Method name
-     * @param array $args Method arguments
+     * @param string $method
+     * @param array $args
      * @return mixed
      */
     public static function __callStatic($method, $args)

src/Phaseolies/Support/LoggerService.php

@@ -22,8 +22,8 @@ class LoggerService extends LogService
     /**
      * Sets the logging channel.
      *
-     * @param string $channel The channel name (e.g., 'stack', 'daily', etc.).
-     * @return self Returns the current instance for method chaining.
+     * @param string $channel
+     * @return self
      */
     public function channel(string $channel): self
     {
@@ -43,8 +43,8 @@ public function channel(string $channel): self
     /**
      * Logs an informational message.
      *
-     * @param mixed $message The message to log.
-     * @param array $context Additional context data.
+     * @param mixed $message
+     * @param array $context
      * @return void
      */
     public function info(mixed $message, array $context = []): void
@@ -57,8 +57,8 @@ public function info(mixed $message, array $context = []): void
     /**
      * Logs a notice message.
      *
-     * @param mixed $message The message to log.
-     * @param array $context Additional context data.
+     * @param mixed $message
+     * @param array $context
      * @return void
      */
     public function notice(mixed $message, array $context = []): void
@@ -71,8 +71,8 @@ public function notice(mixed $message, array $context = []): void
     /**
      * Logs a warning message.
      *
-     * @param mixed $message The message to log.
-     * @param array $context Additional context data.
+     * @param mixed $message
+     * @param array $context
      * @return void
      */
     public function warning(mixed $message, array $context = []): void
@@ -85,8 +85,8 @@ public function warning(mixed $message, array $context = []): void
     /**
      * Logs an error message.
      *
-     * @param mixed $message The message to log.
-     * @param array $context Additional context data.
+     * @param mixed $message
+     * @param array $context
      * @return void
      */
     public function error(mixed $message, array $context = []): void
@@ -99,8 +99,8 @@ public function error(mixed $message, array $context = []): void
     /**
      * Logs a debug message.
      *
-     * @param mixed $message The message to log.
-     * @param array $context Additional context data.
+     * @param mixed $message
+     * @param array $context
      * @return void
      */
     public function debug(mixed $message, array $context = []): void
@@ -113,8 +113,8 @@ public function debug(mixed $message, array $context = []): void
     /**
      * Logs a critical message.
      *
-     * @param mixed $message The message to log.
-     * @param array $context Additional context data.
+     * @param mixed $message
+     * @param array $context
      * @return void
      */
     public function critical(mixed $message, array $context = []): void
@@ -127,8 +127,8 @@ public function critical(mixed $message, array $context = []): void
     /**
      * Logs an alert message.
      *
-     * @param mixed $message The message to log.
-     * @param array $context Additional context data.
+     * @param mixed $message
+     * @param array $context
      * @return void
      */
     public function alert(mixed $message, array $context = []): void
@@ -141,8 +141,8 @@ public function alert(mixed $message, array $context = []): void
     /**
      * Logs an emergency message.
      *
-     * @param mixed $message The message to log.
-     * @param array $context Additional context data.
+     * @param mixed $message
+     * @param array $context
      * @return void
      */
     public function emergency(mixed $message, array $context = []): void
@@ -155,7 +155,7 @@ public function emergency(mixed $message, array $context = []): void
     /**
      * Overrides reader to pass the dynamic channel.
      *
-     * @return Logger The configured Monolog logger instance.
+     * @return Logger
      */
     protected function reader(): Logger
     {

src/Phaseolies/Support/Mail/Driver/MailMailDriver.php

@@ -25,9 +25,9 @@ public function __construct(array $config)
     /**
      * Sends an email using PHP's mail() function.
      *
-     * @param Mailable $message The Mailable object containing email details.
-     * @return bool Returns true if the email is sent successfully, false otherwise.
-     * @throws \Exception Throws an exception if the email could not be sent.
+     * @param Mailable $message
+     * @return bool
+     * @throws \Exception
      */
     public function send(Mailable $message)
     {