Improve some PHPdocs based on existing Symfony stubs in PHPstan and Psalm

Author: mdeboer

Command/Command.php

@@ -19,6 +19,7 @@
 use Symfony\Component\Console\Exception\ExceptionInterface;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\LogicException;
+use Symfony\Component\Console\Helper\HelperInterface;
 use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputDefinition;
@@ -677,6 +678,8 @@ public function getUsages(): array
     /**
      * Gets a helper instance by name.
      *
+     * @return HelperInterface
+     *
      * @throws LogicException           if no HelperSet is defined
      * @throws InvalidArgumentException if the helper is not defined
      */

Command/LazyCommand.php

@@ -15,6 +15,7 @@
 use Symfony\Component\Console\Completion\CompletionInput;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Completion\Suggestion;
+use Symfony\Component\Console\Helper\HelperInterface;
 use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputInterface;
@@ -176,7 +177,7 @@ public function getUsages(): array
         return $this->getCommand()->getUsages();
     }
 
-    public function getHelper(string $name): mixed
+    public function getHelper(string $name): HelperInterface
     {
         return $this->getCommand()->getHelper($name);
     }

Helper/HelperSet.php

@@ -18,15 +18,15 @@
  *
  * @author Fabien Potencier <[email protected]>
  *
- * @implements \IteratorAggregate<string, Helper>
+ * @implements \IteratorAggregate<string, HelperInterface>
  */
 class HelperSet implements \IteratorAggregate
 {
-    /** @var array<string, Helper> */
+    /** @var array<string, HelperInterface> */
     private array $helpers = [];
 
     /**
-     * @param Helper[] $helpers An array of helper
+     * @param HelperInterface[] $helpers
      */
     public function __construct(array $helpers = [])
     {

Output/OutputInterface.php

@@ -33,15 +33,17 @@ interface OutputInterface
     /**
      * Writes a message to the output.
      *
-     * @param $newline Whether to add a newline
-     * @param $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
+     * @param bool                             $newline Whether to add a newline
+     * @param self::VERBOSITY_*|self::OUTPUT_* $options A bitmask of options (one of the OUTPUT or VERBOSITY constants),
+     *                                                  0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
      */
     public function write(string|iterable $messages, bool $newline = false, int $options = 0);
 
     /**
      * Writes a message to the output and adds a newline at the end.
      *
-     * @param $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
+     * @param self::VERBOSITY_*|self::OUTPUT_* $options A bitmask of options (one of the OUTPUT or VERBOSITY constants),
+     *                                                  0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
      */
     public function writeln(string|iterable $messages, int $options = 0);