Merge branch 'hotfix/zendframework/zendframework#5863-method-signatur…

…e-cleanups' Close zendframework/zendframework#5863
zendframework · Mar 17, 2014 · 61aff3c · 61aff3c
2 parents 7cbed25 + ba76fe7
commit 61aff3c
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 5 deletions.
diff --git a/src/Adapter/AbstractAdapter.php b/src/Adapter/AbstractAdapter.php
@@ -361,7 +361,7 @@ public function getHeight()
     /**
      * Determine and return current console width and height.
      *
-     * @return array array($width, $height)
+     * @return int[] array($width, $height)
      */
     public function getSize()
     {

diff --git a/src/Adapter/AdapterInterface.php b/src/Adapter/AdapterInterface.php
@@ -29,6 +29,7 @@ interface AdapterInterface
      * @param string                   $text
      * @param null|int $color
      * @param null|int $bgColor
+     * @return void
      */
     public function write($text, $color = null, $bgColor = null);
 
@@ -38,6 +39,7 @@ public function write($text, $color = null, $bgColor = null);
      * @param string                   $text
      * @param null|int $color
      * @param null|int $bgColor
+     * @return void
      */
     public function writeText($text, $color = null, $bgColor = null);
 
@@ -48,6 +50,7 @@ public function writeText($text, $color = null, $bgColor = null);
      * @param string                   $text
      * @param null|int $color
      * @param null|int $bgColor
+     * @return void
      */
     public function writeLine($text = "", $color = null, $bgColor = null);
 
@@ -59,6 +62,7 @@ public function writeLine($text = "", $color = null, $bgColor = null);
      * @param int                      $y        Console Y coordinate (row)
      * @param null|int $color
      * @param null|int $bgColor
+     * @return void
      */
     public function writeAt($text, $x, $y, $color = null, $bgColor = null);
 
@@ -77,6 +81,7 @@ public function writeAt($text, $x, $y, $color = null, $bgColor = null);
      * @param int      $bgColor      (optional) Background color
      * @param null|int $fillColor    (optional) Foreground color of box fill
      * @param null|int $fillBgColor  (optional) Background color of box fill
+     * @return void
      */
     public function writeBox(
         $x1,
@@ -103,6 +108,7 @@ public function writeBox(
      * @param int                      $y        Block Y coordinate (row)
      * @param null|int                 $color    (optional) Text color
      * @param null|int $bgColor  (optional) Text background color
+     * @return void
      */
     public function writeTextBlock(
         $text,
@@ -148,16 +154,19 @@ public function isUtf8();
      *
      * @param int   $x
      * @param int   $y
+     * @return void
      */
     public function setPos($x, $y);
 
     /**
      * Hide console cursor
+     * @return void
      */
     public function hideCursor();
 
     /**
      * Show console cursor
+     * @return void
      */
     public function showCursor();
 
@@ -174,25 +183,29 @@ public function getTitle();
      * @param string                     $string
      * @param null|int   $color    Foreground color
      * @param null|int   $bgColor  Background color
+     * @return string
      */
     public function colorize($string, $color = null, $bgColor = null);
 
     /**
      * Change current drawing color.
      *
      * @param int $color
+     * @return void
      */
     public function setColor($color);
 
     /**
      * Change current drawing background color
      *
      * @param int $color
+     * @return void
      */
     public function setBgColor($color);
 
     /**
      * Reset color to console default.
+     * @return void
      */
     public function resetColor();
 
@@ -201,6 +214,7 @@ public function resetColor();
      * Set Console charset to use.
      *
      * @param CharsetInterface $charset
+     * @return void
      */
     public function setCharset(CharsetInterface $charset);
 
@@ -218,16 +232,19 @@ public function getDefaultCharset();
 
     /**
      * Clear console screen
+     * @return void
      */
     public function clear();
 
     /**
      * Clear line at cursor position
+     * @return void
      */
     public function clearLine();
 
     /**
      * Clear console screen
+     * @return void
      */
     public function clearScreen();
 

diff --git a/src/Adapter/Posix.php b/src/Adapter/Posix.php
@@ -358,7 +358,7 @@ protected function restoreTTYMode()
      * Change TTY (Console) mode
      *
      * @link  http://en.wikipedia.org/wiki/Stty
-     * @param $mode
+     * @param string $mode
      */
     protected function setTTYMode($mode)
     {

diff --git a/src/Adapter/Windows.php b/src/Adapter/Windows.php
@@ -64,7 +64,7 @@ public function getWidth()
     /**
      * Determine and return current console height.
      *
-     * @return false|int
+     * @return int
      */
     public function getHeight()
     {

diff --git a/src/Color/Xterm256.php b/src/Color/Xterm256.php
@@ -40,7 +40,7 @@ protected function __construct($color = null)
      * Calcluate the X11 color value of a hexadecimal color
      *
      * @param  string $hexColor
-     * @return string
+     * @return self
      */
     public static function calculate($hexColor)
     {

diff --git a/src/Prompt/Line.php b/src/Prompt/Line.php
@@ -51,7 +51,7 @@ public function __construct($promptText = 'Please enter value: ', $allowEmpty =
     /**
      * Show the prompt to user and return the answer.
      *
-     * @return mixed
+     * @return string
      */
     public function show()
     {

diff --git a/src/Prompt/PromptInterface.php b/src/Prompt/PromptInterface.php
@@ -38,6 +38,7 @@ public function getConsole();
      * Set console adapter to use when showing prompt.
      *
      * @param ConsoleAdapter $adapter
+     * @return void
      */
     public function setConsole(ConsoleAdapter $adapter);
 }