Re-introduce @return in dockblocks

Author: josbeir

rector.php

@@ -4,6 +4,8 @@
 use Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector;
 use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
 use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveNullTagValueNodeRector;
+use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector;
 use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector;
 use Rector\ValueObject\PhpVersion;
 
@@ -17,10 +19,13 @@
         DisallowedEmptyRuleFixerRector::class,
         SimplifyIfElseToTernaryRector::class,
         MakeInheritedMethodVisibilitySameAsParentRector::class,
+        RemoveNullTagValueNodeRector::class,
+        RemoveUselessReturnTagRector::class,
     ])
     ->withParallel()
     ->withPreparedSets(
         deadCode: true,
         codeQuality: true,
         codingStyle: true,
+        typeDeclarationDocblocks: true,
     );

src/Command/JobCommand.php

@@ -69,6 +69,7 @@ public function templateData(Arguments $arguments): array
      * Gets the option parser instance and configures it.
      *
      * @param \Cake\Console\ConsoleOptionParser $parser The parser to update.
+     * @return \Cake\Console\ConsoleOptionParser
      */
     public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
     {

src/Command/PurgeFailedCommand.php

@@ -28,6 +28,8 @@ class PurgeFailedCommand extends Command
 
     /**
      * Get the command name.
+     *
+     * @return string
      */
     public static function defaultName(): string
     {
@@ -36,6 +38,8 @@ public static function defaultName(): string
 
     /**
      * Gets the option parser instance and configures it.
+     *
+     * @return \Cake\Console\ConsoleOptionParser
      */
     public function getOptionParser(): ConsoleOptionParser
     {
@@ -68,6 +72,7 @@ public function getOptionParser(): ConsoleOptionParser
     /**
      * @param \Cake\Console\Arguments $args Arguments
      * @param \Cake\Console\ConsoleIo $io ConsoleIo
+     * @return int
      */
     public function execute(Arguments $args, ConsoleIo $io): int
     {

src/Command/RequeueCommand.php

@@ -30,6 +30,8 @@ class RequeueCommand extends Command
 
     /**
      * Get the command name.
+     *
+     * @return string
      */
     public static function defaultName(): string
     {
@@ -38,6 +40,8 @@ public static function defaultName(): string
 
     /**
      * Gets the option parser instance and configures it.
+     *
+     * @return \Cake\Console\ConsoleOptionParser
      */
     public function getOptionParser(): ConsoleOptionParser
     {
@@ -70,6 +74,7 @@ public function getOptionParser(): ConsoleOptionParser
     /**
      * @param \Cake\Console\Arguments $args Arguments
      * @param \Cake\Console\ConsoleIo $io ConsoleIo
+     * @return int
      */
     public function execute(Arguments $args, ConsoleIo $io): int
     {

src/Command/WorkerCommand.php

@@ -53,6 +53,8 @@ public function __construct(
 
     /**
      * Get the command name.
+     *
+     * @return string
      */
     public static function defaultName(): string
     {
@@ -61,6 +63,8 @@ public static function defaultName(): string
 
     /**
      * Gets the option parser instance and configures it.
+     *
+     * @return \Cake\Console\ConsoleOptionParser
      */
     public function getOptionParser(): ConsoleOptionParser
     {
@@ -113,6 +117,7 @@ public function getOptionParser(): ConsoleOptionParser
      *
      * @param \Cake\Console\Arguments $args Arguments
      * @param \Psr\Log\LoggerInterface $logger Logger instance.
+     * @return \Enqueue\Consumption\ExtensionInterface
      */
     protected function getQueueExtension(Arguments $args, LoggerInterface $logger): ExtensionInterface
     {
@@ -149,6 +154,7 @@ protected function getQueueExtension(Arguments $args, LoggerInterface $logger):
      * Creates and returns a LoggerInterface object
      *
      * @param \Cake\Console\Arguments $args Arguments
+     * @return \Psr\Log\LoggerInterface
      */
     protected function getLogger(Arguments $args): LoggerInterface
     {
@@ -166,6 +172,7 @@ protected function getLogger(Arguments $args): LoggerInterface
      * @param \Cake\Console\Arguments $args Arguments
      * @param \Cake\Console\ConsoleIo $io ConsoleIo
      * @param \Psr\Log\LoggerInterface $logger Logger instance
+     * @return \Interop\Queue\Processor
      */
     protected function getProcessor(Arguments $args, ConsoleIo $io, LoggerInterface $logger): InteropProcessor
     {
@@ -190,6 +197,7 @@ protected function getProcessor(Arguments $args, ConsoleIo $io, LoggerInterface
     /**
      * @param \Cake\Console\Arguments $args Arguments
      * @param \Cake\Console\ConsoleIo $io ConsoleIo
+     * @return int
      */
     public function execute(Arguments $args, ConsoleIo $io): int
     {

src/Consumption/LimitAttemptsExtension.php

@@ -26,6 +26,7 @@ class LimitAttemptsExtension implements MessageResultExtensionInterface
 
     /**
      * @param int|null $maxAttempts The maximum number of times a job may be attempted. $maxAttempts defined on a Job will override this value.
+     * @return void
      */
     public function __construct(
         protected readonly ?int $maxAttempts = null,
@@ -34,6 +35,7 @@ public function __construct(
 
     /**
      * @param \Enqueue\Consumption\Context\MessageResult $context The result of the message after it was processed.
+     * @return void
      */
     public function onResult(MessageResult $context): void
     {

src/Consumption/LimitConsumedMessagesExtension.php

@@ -22,6 +22,7 @@ class LimitConsumedMessagesExtension implements PreConsumeExtensionInterface, Po
 
     /**
      * @param int $messageLimit The number of messages to process before exiting.
+     * @return void
      */
     public function __construct(
         protected readonly int $messageLimit,
@@ -33,6 +34,7 @@ public function __construct(
      * The consumption could be interrupted at this step.
      *
      * @param \Enqueue\Consumption\Context\PreConsume $context The PreConsume context.
+     * @return void
      */
     public function onPreConsume(PreConsume $context): void
     {
@@ -47,6 +49,7 @@ public function onPreConsume(PreConsume $context): void
      * The consumption could be interrupted at this point.
      *
      * @param \Enqueue\Consumption\Context\PostConsume $context The PostConsume context.
+     * @return void
      */
     public function onPostConsume(PostConsume $context): void
     {
@@ -61,6 +64,7 @@ public function onPostConsume(PostConsume $context): void
      * Check if the consumer should be stopped.
      *
      * @param \Psr\Log\LoggerInterface $logger The logger where messages will be logged.
+     * @return bool
      */
     protected function shouldBeStopped(LoggerInterface $logger): bool
     {

src/Consumption/RemoveUniqueJobIdFromCacheExtension.php

@@ -13,6 +13,7 @@ class RemoveUniqueJobIdFromCacheExtension implements MessageResultExtensionInter
 {
     /**
      * @param string $cache Cache engine name.
+     * @return void
      */
     public function __construct(
         protected readonly string $cache,
@@ -21,6 +22,7 @@ public function __construct(
 
     /**
      * @param \Enqueue\Consumption\Context\MessageResult $context The result of the message after it was processed.
+     * @return void
      */
     public function onResult(MessageResult $context): void
     {

src/Job/JobInterface.php

@@ -22,6 +22,7 @@ interface JobInterface
      * Executes logic for Job
      *
      * @param \Cake\Queue\Job\Message $message job message
+     * @return string|null
      */
     public function execute(Message $message): ?string;
 }

src/Job/MailerJob.php

@@ -29,6 +29,7 @@ class MailerJob implements JobInterface
      * Constructs and dispatches the event from a job message
      *
      * @param \Cake\Queue\Job\Message $message job message
+     * @return string|null
      */
     public function execute(Message $message): ?string
     {