ekowabaka / clearice

src/ArgumentParser.php

Doc Comments +9 added lines

@@ -213,6 +213,9 @@ 
         return $this->executeCommand($this->command, $this->parsedOptions);
     }
     
+    /**
+     * @return string
+     */
     public function getLookAheadArgument()
     {
         return $this->arguments[$this->argumentPointer + 1];
@@ -351,6 +354,9 @@ 
         return $command;
     } 
     
+    /**
+     * @param string $command
+     */
     private function stringCommandToArray($command)
     {
         return array(
@@ -382,6 +388,9 @@ 
         }
     }
     
+    /**
+     * @param string $option
+     */
     private function stringOptionToArray($option)
     {
         $newOption = array();

src/HelpMessage.php

Doc Comments +8 added lines, -5 removed lines

@@ -80,7 +80,7 @@ 
      * 
      * @param array $commands An array of associative arrays with infomation 
      *                        about all commands configured into ClearIce.
-     * @return array
+     * @return string[]
      */
     private function getCommandsHelp($commands)
     {
@@ -103,7 +103,7 @@ 
      *                          stated in this argument.
      * @param string $title     A descriptive title for the header of this set 
      *                          of options.
-     * @return array
+     * @return string[]
      */    
     private function getOptionsHelp($options, $command = '', $title = 'Options:')
     {
@@ -175,7 +175,7 @@ 
      * @param string $argumentPart
      * @param string $help
      * @param integer $minSize
-     * @return array
+     * @return string
      */
     private function wrapHelp($argumentPart, &$help, $minSize = 29)
     {
@@ -194,7 +194,7 @@ 
      * sring with your option and and wrapping the help message around it.
      * 
      * @param type $option
-     * @return string
+     * @return string[]
      */
     private function formatOptionHelp($option)
     {
@@ -216,7 +216,7 @@ 
      * help message for a given command around the command.
      * 
      * @param type $command
-     * @return string
+     * @return string[]
      */
     private function formatCommandHelp($command)
     {
@@ -230,6 +230,9 @@ 
         return $commandHelp;
     }
     
+    /**
+     * @param string $section
+     */
     private function getDescriptionMessage(array $params, array &$sections, $section)
     {
         if(isset($params[$section])) {

src/parsers/ShortOptionParser.php

Doc Comments +6 added lines

@@ -42,6 +42,9 @@ 
             $this->optionsMap[$command][$shortOption]['long'] : $shortOption;        
     }
     
+    /**
+     * @param string|boolean $remainder
+     */
     private function getValueFromRemainder($remainder)
     {
         $remainder = substr($remainder, 1);
@@ -83,6 +86,9 @@ 
         }
     }
     
+    /**
+     * @param string $argument
+     */
     public function parse($argument, $command)
     {
         $this->skippedShorts = '';