consolidation / annotated-command

src/Parser/Internal/CommandDocBlockParser2.php

Unused Use Statements -2 removed lines

@@ -4,8 +4,6 @@
 use phpDocumentor\Reflection\DocBlock;
 use phpDocumentor\Reflection\DocBlock\Tag\ParamTag;
 use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
-use Consolidation\AnnotatedCommand\Parser\CommandInfo;
-use Consolidation\AnnotatedCommand\Parser\DefaultsWithDescriptions;
 
 /**
  * Given a class and method name, parse the annotations in the

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/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) {

Unused Use Statements -2 removed lines

@@ -3,8 +3,6 @@
 
 use Consolidation\AnnotatedCommand\Hooks\HookManager;
 use Consolidation\AnnotatedCommand\Parser\CommandInfo;
-use Consolidation\OutputFormatters\FormatterManager;
-use Consolidation\OutputFormatters\Options\FormatterOptions;
 use Consolidation\AnnotatedCommand\Help\HelpDocumentAlter;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;

src/Parser/CommandInfo.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 namespace Consolidation\AnnotatedCommand\Parser;
 
 use Symfony\Component\Console\Input\InputOption;
-use Consolidation\AnnotatedCommand\Parser\Internal\CommandDocBlockParser;
 use Consolidation\AnnotatedCommand\Parser\Internal\CommandDocBlockParserFactory;
 use Consolidation\AnnotatedCommand\AnnotationData;
 

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

Doc Comments +2 added lines, -1 removed lines

@@ -301,7 +301,7 @@ 
      * @param int $status
      * @param string $structuredOutput
      * @param mixed $originalResult
-     * @return type
+     * @return integer
      */
     protected function writeErrorMessage($output, $status, $structuredOutput, $originalResult)
     {
@@ -331,6 +331,7 @@ 
     /**
      * If a status code was set, then return it; otherwise,
      * presume success.
+     * @param null|integer $status
      */
     protected function interpretStatusCode($status)
     {

Unused Use Statements -2 removed lines

@@ -7,12 +7,10 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Output\ConsoleOutputInterface;
-
 use Consolidation\OutputFormatters\FormatterManager;
 use Consolidation\OutputFormatters\Options\FormatterOptions;
 use Consolidation\AnnotatedCommand\Hooks\HookManager;
 use Consolidation\AnnotatedCommand\Options\PrepareFormatter;
-
 use Consolidation\AnnotatedCommand\Hooks\Dispatchers\InitializeHookDispatcher;
 use Consolidation\AnnotatedCommand\Hooks\Dispatchers\OptionsHookDispatcher;
 use Consolidation\AnnotatedCommand\Hooks\Dispatchers\InteractHookDispatcher;