consolidation / annotated-command

src/Hooks/HookManager.php

Doc Comments +39 added lines, -1 removed lines

@@ -60,7 +60,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)
@@ -73,11 +73,17 @@ 
         $this->hooks[$name][$hook][] = $callback;
     }
 
+    /**
+     * @param \Consolidation\AnnotatedCommand\Parser\CommandInfo $commandInfo
+     */
     public function recordHookOptions($commandInfo, $name)
     {
         $this->hookOptions[$name][] = $commandInfo;
     }
 
+    /**
+     * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command
+     */
     public static function getNames($command, $callback)
     {
         return array_filter(
@@ -289,6 +295,9 @@ 
         $command->optionsHookForHookAnnotations($commandInfoList);
     }
 
+    /**
+     * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command
+     */
     protected function getHookOptionsForCommand($command)
     {
         if (isset($this->hookOptions[$command->getName()])) {
@@ -389,6 +398,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string[] $names
+     */
     protected function getCommandEventHooks($names)
     {
         return $this->getHooks($names, self::COMMAND_EVENT);
@@ -449,6 +461,7 @@ 
      * @param string|array $names The name of the function being hooked.
      * @param string $hook The specific hook name (e.g. alter)
      * @param string[] $stages The stages to apply hooks at (e.g. pre, post)
+     * @param AnnotationData $annotationData
      *
      * @return callable[]
      */
@@ -499,6 +512,10 @@ 
         return [];
     }
 
+    /**
+     * @param callable $provider
+     * @param InputInterface $input
+     */
     protected function callInjectConfigurationHook($provider, $input, AnnotationData $annotationData)
     {
         if ($provider instanceof InitializeHookInterface) {
@@ -509,6 +526,10 @@ 
         }
     }
 
+    /**
+     * @param callable $optionHook
+     * @param \Consolidation\AnnotatedCommand\AnnotatedCommand $command
+     */
     protected function callOptionHook($optionHook, $command, AnnotationData $annotationData)
     {
         if ($optionHook instanceof OptionHookInterface) {
@@ -519,6 +540,11 @@ 
         }
     }
 
+    /**
+     * @param callable $interactor
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
     protected function callInteractor($interactor, $input, $output, AnnotationData $annotationData)
     {
         if ($interactor instanceof InteractorInterface) {
@@ -529,6 +555,9 @@ 
         }
     }
 
+    /**
+     * @param callable $validator
+     */
     protected function callValidator($validator, $args, AnnotationData $annotationData)
     {
         // TODO: Adding AnnotationData to ValidatorInterface would be
@@ -542,6 +571,9 @@ 
         }
     }
 
+    /**
+     * @param callable $processor
+     */
     protected function callProcessor($processor, $result, $args, AnnotationData $annotationData)
     {
         $processed = null;
@@ -560,6 +592,9 @@ 
         return $result;
     }
 
+    /**
+     * @param callable $determiner
+     */
     protected function callDeterminer($determiner, $result)
     {
         if ($determiner instanceof StatusDeterminerInterface) {
@@ -570,6 +605,9 @@ 
         }
     }
 
+    /**
+     * @param callable $extractor
+     */
     protected function callExtractor($extractor, $result)
     {
         if ($extractor instanceof ExtractOutputInterface) {

src/Parser/Internal/AbstractCommandDocBlockParser.php

Doc Comments +2 added lines

@@ -207,6 +207,7 @@ 
     /**
      * Given a docblock description in the form "$variable description",
      * return the variable name and description via the 'match' parameter.
+     * @param string $source
      */
     protected function pregMatchNameAndDescription($source, &$match)
     {
@@ -220,6 +221,7 @@ 
     /**
      * Given a docblock description in the form "$variable description",
      * return the variable name and description via the 'match' parameter.
+     * @param string $source
      */
     protected function pregMatchOptionNameAndDescription($source, &$match)
     {

src/CommandData.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     /**
      * For internal use only; indicates that the function to be called
      * should be passed an InputInterface &/or an OutputInterface.
-     * @param booean $usesInputInterface
+     * @param boolean $usesInputInterface
      * @param boolean $usesOutputInterface
      * @return self
      */

src/Options/PrepareTerminalWidthOption.php

Doc Comments +3 added lines

@@ -43,6 +43,9 @@
         $options->setWidth($width);
     }
 
+    /**
+     * @return CommandData
+     */
     protected function getTerminalWidth()
     {
         if (!$this->application) {

src/AnnotatedCommand.php

Doc Comments +19 added lines

@@ -38,6 +38,9 @@ 
     protected $usesOutputInterface;
     protected $returnType;
 
+    /**
+     * @param string $name
+     */
     public function __construct($name = null)
     {
         $commandInfo = false;
@@ -67,6 +70,9 @@ 
         return $this;
     }
 
+    /**
+     * @param CommandProcessor $commandProcessor
+     */
     public function setCommandProcessor($commandProcessor)
     {
         $this->commandProcessor = $commandProcessor;
@@ -120,6 +126,9 @@ 
         return $this;
     }
 
+    /**
+     * @param CommandInfo $commandInfo
+     */
     public function setCommandInfo($commandInfo)
     {
         $this->setDescription($commandInfo->getDescription());
@@ -198,6 +207,10 @@ 
         return $dom;
     }
 
+    /**
+     * @param \DOMDocument $dom
+     * @param string $tagName
+     */
     protected function getSingleElementByTagName($dom, $parent, $tagName)
     {
         // There should always be exactly one '<command>' element.
@@ -275,6 +288,9 @@ 
         return InputArgument::OPTIONAL;
     }
 
+    /**
+     * @param CommandInfo $commandInfo
+     */
     public function setCommandOptions($commandInfo, $automaticOptions = [])
     {
         $inputOptions = $commandInfo->inputOptions();
@@ -345,6 +361,9 @@ 
         );
     }
 
+    /**
+     * @param Hooks\CommandInfo[] $commandInfoList
+     */
     public function optionsHookForHookAnnotations($commandInfoList)
     {
         foreach ($commandInfoList as $commandInfo) {

src/Parser/CommandInfo.php

Doc Comments +9 added lines, -3 removed lines

@@ -129,6 +129,9 @@ 
         return new self($classNameOrInstance, $methodName, $cache);
     }
 
+    /**
+     * @param string $methodName
+     */
     protected function constructFromClassAndMethod($classNameOrInstance, $methodName)
     {
         $this->otherAnnotations = new AnnotationData();
@@ -423,7 +426,7 @@ 
     /**
      * Set aliases that can be used in place of the command's primary name.
      *
-     * @param string|string[] $aliases
+     * @param string $aliases
      */
     public function setAliases($aliases)
     {
@@ -477,7 +480,7 @@ 
     /**
      * Return the list of refleaction parameters.
      *
-     * @return ReflectionParameter[]
+     * @return \ReflectionParameter[]
      */
     public function getParameters()
     {
@@ -608,7 +611,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()
     {
@@ -628,6 +631,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)
     {
@@ -718,6 +722,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)
     {