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/CommandProcessor.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
      * @param int $status
      * @param string $structuredOutput
      * @param mixed $originalResult
-     * @return type
+     * @return integer
      */
     protected function writeErrorMessage($output, $status, $structuredOutput, $originalResult)
     {

src/AnnotatedCommand.php

Doc Comments +15 added lines

@@ -35,6 +35,9 @@ 
     protected $usesOutputInterface;
     protected $returnType;
 
+    /**
+     * @param string $name
+     */
     public function __construct($name = null)
     {
         $commandInfo = false;
@@ -63,6 +66,9 @@ 
         $this->commandCallback = $commandCallback;
     }
 
+    /**
+     * @param CommandProcessor $commandProcessor
+     */
     public function setCommandProcessor($commandProcessor)
     {
         $this->commandProcessor = $commandProcessor;
@@ -102,6 +108,9 @@ 
         $this->annotationData = $annotationData;
     }
 
+    /**
+     * @param CommandInfo $commandInfo
+     */
     public function setCommandInfo($commandInfo)
     {
         $this->setDescription($commandInfo->getDescription());
@@ -178,6 +187,9 @@ 
         return InputArgument::OPTIONAL;
     }
 
+    /**
+     * @param CommandInfo $commandInfo
+     */
     public function setCommandOptions($commandInfo, $automaticOptions = [])
     {
         $inputOptions = $commandInfo->inputOptions();
@@ -247,6 +259,9 @@ 
         );
     }
 
+    /**
+     * @param Hooks\CommandInfo[] $commandInfoList
+     */
     public function optionsHookForHookAnnotations($commandInfoList)
     {
         foreach ($commandInfoList as $commandInfo) {

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
      */