consolidation / annotated-command

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/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 +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/CommandData.php

Doc Comments +4 added lines, -1 removed lines

@@ -40,7 +40,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
      */
@@ -151,6 +151,9 @@ 
         return in_array($option, $this->specialDefaults);
     }
 
+    /**
+     * @param \Symfony\Component\Console\Input\InputDefinition $definition
+     */
     public function cacheSpecialDefaults($definition)
     {
         foreach ($definition->getOptions() as $option => $inputOption) {

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/Parser/Internal/BespokeDocBlockParser.php

Doc Comments +3 added lines

@@ -230,6 +230,9 @@
         return !empty($nextLine);
     }
 
+    /**
+     * @param DocblockTag[] $tags
+     */
     protected function processAllTags($tags)
     {
         // Iterate over all of the tags, and process them as necessary.