ekowabaka / clearice

src/HelpMessage.php

Doc Comments +7 added lines, -4 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)
     {
@@ -184,7 +184,7 @@ 
      * @param string $argumentPart
      * @param string $help
      * @param integer $minSize
-     * @return array
+     * @return string
      */
     private function wrapHelp($argumentPart, &$help, $minSize = 29)
     {
@@ -203,7 +203,7 @@ 
      * sring with your option and and wrapping the help message around it.
      * 
      * @param type $option
-     * @return string
+     * @return string[]
      */
     private function formatOptionHelp($option)
     {
@@ -225,7 +225,7 @@ 
      * help message for a given command around the command.
      * 
      * @param type $command
-     * @return string
+     * @return string[]
      */
     private function formatCommandHelp($command)
     {
@@ -239,6 +239,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

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