consolidation / annotated-command

src/Parser/Internal/BespokeDocBlockParser.php

Doc Comments +6 added lines

@@ -146,6 +146,9 @@ 
         $this->commandInfo->setReturnType($returnType);
     }
 
+    /**
+     * @param string $doc
+     */
     private function parseDocBlock($doc)
     {
         if (empty($doc)) {
@@ -198,6 +201,9 @@ 
         $this->commandInfo->setHelp($help);
     }
 
+    /**
+     * @param DocblockTag[] $tags
+     */
     protected function processAllTags($tags)
     {
         // Iterate over all of the tags, and process them as necessary.

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 namespace Consolidation\AnnotatedCommand\Parser\Internal;
 
-use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 use Consolidation\AnnotatedCommand\Parser\DefaultsWithDescriptions;
 
 /**

Spacing +5 added lines, -5 removed lines

@@ -36,7 +36,7 @@ 
     protected function processCommandTag($tag)
     {
         if (!$tag->hasWordAndDescription($matches)) {
-            throw new \Exception('Could not determine command name from tag ' . (string)$tag);
+            throw new \Exception('Could not determine command name from tag '.(string)$tag);
         }
         $commandName = $matches['word'];
         $this->commandInfo->setName($commandName);
@@ -118,7 +118,7 @@ 
     {
         $lines = explode("\n", $tag->getContent());
         $usage = trim(array_shift($lines));
-        $description = static::removeLineBreaks(implode("\n", array_map(function ($line) {
+        $description = static::removeLineBreaks(implode("\n", array_map(function($line) {
             return trim($line);
         }, $lines)));
 
@@ -139,7 +139,7 @@ 
     protected function processReturnTag($tag)
     {
         if (!$tag->hasWordAndDescription($matches)) {
-            throw new \Exception('Could not determine return type from tag ' . (string)$tag);
+            throw new \Exception('Could not determine return type from tag '.(string)$tag);
         }
         // TODO: look at namespace and `use` statments to make returnType a fqdn
         $returnType = $matches['word'];
@@ -179,7 +179,7 @@ 
         // Trim all of the lines individually.
         $lines =
             array_map(
-                function ($line) {
+                function($line) {
                     return trim($line);
                 },
                 $lines
@@ -188,7 +188,7 @@ 
         // Everything up to the first blank line goes in the description.
         $description = array_shift($lines);
         while (!empty($lines) && !empty(trim($lines[0]))) {
-            $description .= ' ' . array_shift($lines);
+            $description .= ' '.array_shift($lines);
         }
 
         // Everything else goes in the help.

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

Spacing +5 added lines, -5 removed lines

@@ -45,7 +45,7 @@ 
      */
     public static function splitTagAndContent($subject, &$matches)
     {
-        $regex = '/' . self::TAG_REGEX . self::DESCRIPTION_REGEX . '/';
+        $regex = '/'.self::TAG_REGEX.self::DESCRIPTION_REGEX.'/';
         return preg_match($regex, $subject, $matches);
     }
 
@@ -92,7 +92,7 @@ 
      */
     public function __toString()
     {
-        return '@' . $this->getTag() . ' ' . $this->getContent();
+        return '@'.$this->getTag().' '.$this->getContent();
     }
 
     /**
@@ -122,7 +122,7 @@ 
      */
     public function hasVariableAndDescription(&$matches)
     {
-        $regex = '/' . self::VARIABLE_OR_WORD_REGEX . self::DESCRIPTION_REGEX . '/';
+        $regex = '/'.self::VARIABLE_OR_WORD_REGEX.self::DESCRIPTION_REGEX.'/';
         return preg_match($regex, $this->getContent(), $matches);
     }
 
@@ -136,7 +136,7 @@ 
      */
     public function hasTypeVariableAndDescription(&$matches)
     {
-        $regex = '/' . self::TYPE_REGEX . self::VARIABLE_REGEX . self::DESCRIPTION_REGEX . '/';
+        $regex = '/'.self::TYPE_REGEX.self::VARIABLE_REGEX.self::DESCRIPTION_REGEX.'/';
         return preg_match($regex, $this->getContent(), $matches);
     }
 
@@ -149,7 +149,7 @@ 
      */
     public function hasWordAndDescription(&$matches)
     {
-        $regex = '/' . self::WORD_REGEX . self::DESCRIPTION_REGEX . '/';
+        $regex = '/'.self::WORD_REGEX.self::DESCRIPTION_REGEX.'/';
         return preg_match($regex, $this->getContent(), $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)) {