Simplify dummy phpdocs

Author: mvorisek

phpstan.neon.dist

@@ -21,6 +21,16 @@ parameters:
             identifier: if.condNotBoolean
             message: '~^Only booleans are allowed in an if condition, mixed given\.$~'
             count: 1
+        -
+            message: '~^Parameter #1 \$(redisAPI|redis) \(Redis\|RedisCluster\) of method malkusch\\lock\\mutex\\PHPRedisMutex::(add|evalScript)\(\) should be contravariant with parameter \$redisAPI \(mixed\) of method malkusch\\lock\\mutex\\RedisMutex::(add|evalScript)\(\)$~'
+            identifier: method.childParameterType
+            path: 'src/mutex/PHPRedisMutex.php'
+            count: 2
+        -
+            message: '~^Parameter #1 \$(redisAPI|client) \(Predis\\ClientInterface\) of method malkusch\\lock\\mutex\\PredisMutex::(add|evalScript)\(\) should be contravariant with parameter \$redisAPI \(mixed\) of method malkusch\\lock\\mutex\\RedisMutex::(add|evalScript)\(\)$~'
+            identifier: method.childParameterType
+            path: 'src/mutex/PredisMutex.php'
+            count: 2
         -
             path: 'tests/mutex/*Test.php'
             identifier: empty.notAllowed
@@ -31,3 +41,8 @@ parameters:
             identifier: method.deprecated
             message: '~^Call to deprecated method getMockForAbstractClass\(\) of class PHPUnit\\Framework\\TestCase:\nhttps://github.com/sebastianbergmann/phpunit/issues/5241$~'
             count: 8
+        -
+            path: 'tests/mutex/PredisMutexTest.php'
+            identifier: method.deprecated
+            message: '~^Call to deprecated method addMethods\(\) of class PHPUnit\\Framework\\MockObject\\MockBuilder:\nhttps://github.com/sebastianbergmann/phpunit/issues/5320$~'
+            count: 1

src/exception/ExecutionOutsideLockException.php

@@ -21,10 +21,8 @@ class ExecutionOutsideLockException extends LockReleaseException
     /**
      * Creates a new instance of the ExecutionOutsideLockException class.
      *
-     * @param float $elapsedTime total elapsed time of the synchronized code callback execution
-     * @param float $timeout     the lock timeout in seconds
-     *
-     * @return self execution outside lock exception
+     * @param float $elapsedTime Total elapsed time of the synchronized code callback execution
+     * @param float $timeout     The lock timeout in seconds
      */
     public static function create(float $elapsedTime, float $timeout): self
     {

src/exception/LockReleaseException.php

@@ -31,7 +31,7 @@ class LockReleaseException extends MutexException
      * Gets the result that has been returned during the critical code
      * execution.
      *
-     * @return mixed the return value of the executed code block
+     * @return mixed The return value of the executed code block
      */
     public function getCodeResult()
     {
@@ -42,9 +42,9 @@ public function getCodeResult()
      * Sets the result that has been returned during the critical code
      * execution.
      *
-     * @param mixed $codeResult the return value of the executed code block
+     * @param mixed $codeResult The return value of the executed code block
      *
-     * @return self current lock release exception instance
+     * @return $this
      */
     public function setCodeResult($codeResult): self
     {
@@ -57,7 +57,7 @@ public function setCodeResult($codeResult): self
      * Gets the exception that has happened during the synchronized code
      * execution.
      *
-     * @return \Throwable|null the exception thrown by the code block or null when there has been no exception
+     * @return \Throwable|null The exception thrown by the code block or null when there has been no exception
      */
     public function getCodeException(): ?\Throwable
     {
@@ -68,9 +68,9 @@ public function getCodeException(): ?\Throwable
      * Sets the exception that has happened during the critical code
      * execution.
      *
-     * @param \Throwable $codeException the exception thrown by the code block
+     * @param \Throwable $codeException The exception thrown by the code block
      *
-     * @return self current lock release exception instance
+     * @return $this
      */
     public function setCodeException(\Throwable $codeException): self
     {

src/exception/MutexException.php

@@ -12,6 +12,6 @@
  */
 class MutexException extends \RuntimeException implements PhpLockException
 {
-    /** @var int not enough redis servers */
+    /** Not enough redis servers */
     public const REDIS_NOT_ENOUGH_SERVERS = 1;
 }

src/exception/TimeoutException.php

@@ -15,9 +15,7 @@ class TimeoutException extends LockAcquireException
     /**
      * Creates a new instance of the TimeoutException class.
      *
-     * @param float $timeout the timeout in seconds
-     *
-     * @return self a timeout has been exceeded exception
+     * @param float $timeout The timeout in seconds
      */
     public static function create(float $timeout): self
     {

src/mutex/CASMutex.php

@@ -17,17 +17,15 @@
  */
 class CASMutex extends Mutex
 {
-    /** @var Loop the loop */
+    /** @var Loop */
     private $loop;
 
     /**
      * Sets the timeout.
      *
-     * The default is 3 seconds.
+     * @param float $timeout The timeout in seconds
      *
-     * @param float $timeout the timeout in seconds
-     *
-     * @throws \LengthException the timeout must be greater than 0
+     * @throws \LengthException The timeout must be greater than 0
      */
     public function __construct(float $timeout = 3)
     {
@@ -66,8 +64,8 @@ public function notify(): void
      * });
      * </code>
      *
-     * @throws \Exception       the execution block threw an exception
-     * @throws TimeoutException the timeout was reached
+     * @throws \Exception       The execution block threw an exception
+     * @throws TimeoutException The timeout was reached
      */
     #[\Override]
     public function synchronized(callable $code)

src/mutex/FlockMutex.php

@@ -33,7 +33,7 @@ class FlockMutex extends LockMutex
      */
     public const STRATEGY_BUSY = 3;
 
-    /** @var resource the file handle */
+    /** @var resource */
     private $fileHandle;
 
     /** @var float */
@@ -45,7 +45,7 @@ class FlockMutex extends LockMutex
     /**
      * Sets the file handle.
      *
-     * @param resource $fileHandle the file handle
+     * @param resource $fileHandle
      */
     public function __construct($fileHandle, float $timeout = self::INFINITE_TIMEOUT)
     {

src/mutex/LockMutex.php

@@ -19,14 +19,14 @@ abstract class LockMutex extends Mutex
      *
      * This method blocks until the lock was acquired.
      *
-     * @throws LockAcquireException the lock could not be acquired
+     * @throws LockAcquireException The lock could not be acquired
      */
     abstract protected function lock(): void;
 
     /**
      * Releases the lock.
      *
-     * @throws LockReleaseException the lock could not be released
+     * @throws LockReleaseException The lock could not be released
      */
     abstract protected function unlock(): void;
 

src/mutex/MemcachedMutex.php

@@ -9,7 +9,7 @@
  */
 class MemcachedMutex extends SpinlockMutex
 {
-    /** @var \Memcached the connected Memcached API */
+    /** @var \Memcached */
     private $memcache;
 
     /**
@@ -18,11 +18,10 @@ class MemcachedMutex extends SpinlockMutex
      * The Memcached API needs to have at least one server in its pool. I.e.
      * it has to be added with Memcached::addServer().
      *
-     * @param string     $name     the lock name
-     * @param \Memcached $memcache the connected Memcached API
-     * @param float      $timeout  the time in seconds a lock expires, default is 3
+     * @param string $name    The lock name
+     * @param float  $timeout The time in seconds a lock expires
      *
-     * @throws \LengthException the timeout must be greater than 0
+     * @throws \LengthException The timeout must be greater than 0
      */
     public function __construct(string $name, \Memcached $memcache, float $timeout = 3)
     {

src/mutex/Mutex.php

@@ -26,14 +26,14 @@ abstract class Mutex
      *
      * @template T
      *
-     * @param callable(): T $code the synchronized execution callback
+     * @param callable(): T $code The synchronized execution callback
      *
-     * @return T the return value of the execution callback
+     * @return T
      *
-     * @throws \Exception                    the execution callback threw an exception
-     * @throws LockAcquireException          the mutex could not be acquired, no further side effects
-     * @throws LockReleaseException          the mutex could not be released, the code was already executed
-     * @throws ExecutionOutsideLockException some code has been executed outside of the lock
+     * @throws \Exception                    The execution callback threw an exception
+     * @throws LockAcquireException          The mutex could not be acquired, no further side effects
+     * @throws LockReleaseException          The mutex could not be released, the code was already executed
+     * @throws ExecutionOutsideLockException Some code has been executed outside of the lock
      */
     abstract public function synchronized(callable $code);
 
@@ -52,10 +52,10 @@ abstract public function synchronized(callable $code);
      * });
      * </code>
      *
-     * @param callable(): bool $check callback that decides if the lock should be acquired and if the synchronized
+     * @param callable(): bool $check Callback that decides if the lock should be acquired and if the synchronized
      *                                callback should be executed after acquiring the lock
      *
-     * @return DoubleCheckedLocking the double-checked locking pattern
+     * @return DoubleCheckedLocking The double-checked locking pattern
      */
     public function check(callable $check): DoubleCheckedLocking
     {