consolidation / annotated-command

src/Parser/CommandInfo.php

Doc Comments +8 added lines, -2 removed lines

@@ -137,6 +137,9 @@ 
         return filemtime($path) != $cache['mtime'];
     }
 
+    /**
+     * @param string $methodName
+     */
     protected function constructFromClassAndMethod($classNameOrInstance, $methodName)
     {
         $this->otherAnnotations = new AnnotationData();
@@ -400,7 +403,7 @@ 
     /**
      * Return the list of refleaction parameters.
      *
-     * @return ReflectionParameter[]
+     * @return \ReflectionParameter[]
      */
     public function getParameters()
     {
@@ -540,7 +543,7 @@ 
      * Examine the parameters of the method for this command, and
      * build a list of commandline arguements for them.
      *
-     * @return array
+     * @return DefaultsWithDescriptions
      */
     protected function determineAgumentClassifications()
     {
@@ -560,6 +563,7 @@ 
      * Examine the provided parameter, and determine whether it
      * is a parameter that will be filled in with a positional
      * commandline argument.
+     * @param DefaultsWithDescriptions $result
      */
     protected function addParameterToResult($result, $param)
     {
@@ -650,6 +654,8 @@ 
     /**
      * Given a list that might be 'a b c' or 'a, b, c' or 'a,b,c',
      * convert the data into the last of these forms.
+     * @param string $text
+     * @return string
      */
     protected static function convertListToCommaSeparated($text)
     {

src/Options/PrepareTerminalWidthOption.php

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
         $options->setWidth($width);
     }
 
+    /**
+     * @return CommandData
+     */
     protected function getTerminalWidth()
     {
         // Don't wrap if wrapping has been disabled.

src/Parser/Internal/DocblockTag.php

Doc Comments +5 added lines, -9 removed lines

@@ -29,7 +29,7 @@ 
     /**
      * Check if the provided string begins with a tag
      * @param string $subject
-     * @return bool
+     * @return integer
      */
     public static function isTag($subject)
     {
@@ -41,7 +41,7 @@ 
      *
      * @param string $subject
      * @param string[] &$matches Sets $matches['tag'] and $matches['description']
-     * @return bool
+     * @return integer
      */
     public static function splitTagAndContent($subject, &$matches)
     {
@@ -101,7 +101,6 @@ 
      * - "@tag $variable description"
      * - "@tag type $variable description"
      *
-     * @param string $subject
      * @param string[] &$matches Sets $matches['variable'] and
      *   $matches['description']; might set $matches['type'].
      * @return bool
@@ -115,10 +114,9 @@ 
 
     /**
      * Determine if tag is "@tag $variable description"
-     * @param string $subject
      * @param string[] &$matches Sets $matches['variable'] and
      *   $matches['description']
-     * @return bool
+     * @return integer
      */
     public function hasVariableAndDescription(&$matches)
     {
@@ -129,10 +127,9 @@ 
     /**
      * Determine if tag is "@tag type $variable description"
      *
-     * @param string $subject
      * @param string[] &$matches Sets $matches['variable'],
      *   $matches['description'] and $matches['type'].
-     * @return bool
+     * @return integer
      */
     public function hasTypeVariableAndDescription(&$matches)
     {
@@ -142,10 +139,9 @@ 
 
     /**
      * Determine if tag is "@tag word description"
-     * @param string $subject
      * @param string[] &$matches Sets $matches['word'] and
      *   $matches['description']
-     * @return bool
+     * @return integer
      */
     public function hasWordAndDescription(&$matches)
     {

src/Parser/Internal/TagFactory.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
         $this->tags = [];
     }
 
+    /**
+     * @param string $line
+     */
     public function parseLine($line)
     {
         if (DocblockTag::isTag($line)) {

src/Hooks/HookManager.php

Doc Comments +10 added lines, -1 removed lines

@@ -68,7 +68,7 @@ 
     /**
      * Add a hook
      *
-     * @param mixed $callback The callback function to call
+     * @param callable $callback The callback function to call
      * @param string   $hook     The name of the hook to add
      * @param string   $name     The name of the command to hook
      *   ('*' for all)
@@ -82,12 +82,18 @@ 
         return $this;
     }
 
+    /**
+     * @param \Consolidation\AnnotatedCommand\Parser\CommandInfo $commandInfo
+     */
     public function recordHookOptions($commandInfo, $name)
     {
         $this->hookOptions[$name][] = $commandInfo;
         return $this;
     }
 
+    /**
+     * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command
+     */
     public static function getNames($command, $callback)
     {
         return array_filter(
@@ -324,6 +330,9 @@ 
         return $this;
     }
 
+    /**
+     * @param Command $command
+     */
     public function getHookOptionsForCommand($command)
     {
         $names = $this->addWildcardHooksToNames($command->getNames(), $command->getAnnotationData());

src/Options/AlterOptionsCommandEvent.php

Doc Comments +3 added lines

@@ -64,6 +64,9 @@
         }
     }
 
+    /**
+     * @param Command $command
+     */
     public function findAndAddHookOptions($command)
     {
         if (!$command instanceof AnnotatedCommand) {

src/Hooks/Dispatchers/StatusDeterminerHookDispatcher.php

Doc Comments +3 added lines

@@ -39,6 +39,9 @@
         }
     }
 
+    /**
+     * @param callable $determiner
+     */
     protected function callDeterminer($determiner, $result)
     {
         if ($determiner instanceof StatusDeterminerInterface) {

src/Input/StdinHandler.php

Doc Comments +3 added lines

@@ -210,6 +210,9 @@
         return !empty($path) && ($path != '-');
     }
 
+    /**
+     * @param string $optionOrArg
+     */
     protected function getOptionOrArg(InputInterface $input, $optionOrArg)
     {
         if ($input->hasOption($optionOrArg)) {

src/ParameterInjection.php

Doc Comments +6 added lines

@@ -13,11 +13,17 @@
         $this->register('Symfony\Component\Console\Output\OutputInterface', $this);
     }
 
+    /**
+     * @param string $interfaceName
+     */
     public function register($interfaceName, ParameterInjector $injector)
     {
         $this->injectors[$interfaceName] = $injector;
     }
 
+    /**
+     * @param CommandData $commandData
+     */
     public function args($commandData)
     {
         return array_merge(