Fixes DocBlocks in Zend_Barcode_Object_ObjectAbstract

Author: froschdesign

library/Zend/Barcode/Object/ObjectAbstract.php

@@ -213,8 +213,8 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Constructor
+     *
      * @param array|Zend_Config $options
-     * @return void
      */
     public function __construct($options = null)
     {
@@ -304,7 +304,7 @@ public function getType()
      * Set height of the barcode bar
      * @param integer $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setBarHeight($value)
     {
@@ -331,7 +331,7 @@ public function getBarHeight()
      * Set thickness of thin bar
      * @param integer $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setBarThinWidth($value)
     {
@@ -358,7 +358,7 @@ public function getBarThinWidth()
      * Set thickness of thick bar
      * @param integer $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setBarThickWidth($value)
     {
@@ -386,7 +386,7 @@ public function getBarThickWidth()
      * thinBarWidth - thickBarWidth - barHeight - fontSize
      * @param float $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setFactor($value)
     {
@@ -414,7 +414,7 @@ public function getFactor()
      * Set color of the barcode and text
      * @param string $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setForeColor($value)
     {
@@ -444,7 +444,7 @@ public function getForeColor()
      * Set the color of the background
      * @param integer $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setBackgroundColor($value)
     {
@@ -526,7 +526,7 @@ public function setReverseColor()
      * Set orientation of barcode and text
      * @param float $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setOrientation($value)
     {
@@ -569,8 +569,10 @@ public function getText()
 
     /**
      * Automatically add leading zeros if barcode length is fixed
-     * @param string $text
+     *
+     * @param string  $text
      * @param boolean $withoutChecksum
+     * @return string
      */
     protected function _addLeadingZeros($text, $withoutChecksum = false)
     {
@@ -637,7 +639,7 @@ public function getDrawText()
      * of the characters to the position of the bars
      * @param boolean $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setStretchText($value)
     {
@@ -686,7 +688,7 @@ public function getWithChecksum()
      * added to the barcode text
      * @param boolean $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setWithChecksumInText($value)
     {
@@ -724,7 +726,7 @@ public static function setBarcodeFont($font)
      *  - if string, $value is assumed to be the path to a TTF font
      * @param integer|string $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setFont($value)
     {
@@ -766,7 +768,7 @@ public function getFont()
      * Set the size of the font in case of TTF
      * @param float $value
      * @return Zend_Barcode_Object
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     public function setFontSize($value)
     {
@@ -848,13 +850,14 @@ protected function _addPolygon(array $points, $color = null, $filled = true)
 
     /**
      * Add a text drawing instruction in the set of instructions
-     * @param string $text
-     * @param float $size
-     * @param array $position
-     * @param string $font
-     * @param integer $color
-     * @param string $alignment
-     * @param float $orientation
+     *
+     * @param string    $text
+     * @param float     $size
+     * @param array     $position
+     * @param string    $font
+     * @param integer   $color
+     * @param string    $alignment
+     * @param float|int $orientation
      */
     protected function _addText(
         $text,
@@ -882,7 +885,8 @@ protected function _addText(
 
     /**
      * Checking of parameters after all settings
-     * @return void
+     *
+     * @return bool
      */
     public function checkParams()
     {
@@ -894,8 +898,10 @@ public function checkParams()
 
     /**
      * Check if a text is really provided to barcode
+     *
+     * @param string|null $value
      * @return void
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     protected function _checkText($value = null)
     {
@@ -913,10 +919,11 @@ protected function _checkText($value = null)
 
     /**
      * Check the ratio between the thick and the thin bar
-     * @param integer $min
-     * @param integer $max
+     *
+     * @param int $min
+     * @param int $max
      * @return void
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     protected function _checkRatio($min = 2, $max = 3)
     {
@@ -934,8 +941,9 @@ protected function _checkRatio($min = 2, $max = 3)
 
     /**
      * Drawing with an angle is just allow TTF font
+     *
      * @return void
-     * @throw Zend_Barcode_Object_Exception
+     * @throws Zend_Barcode_Object_Exception
      */
     protected function _checkFontAndOrientation()
     {
@@ -948,8 +956,8 @@ protected function _checkFontAndOrientation()
     }
 
     /**
-     * Width of the result image
-     * (before any rotation)
+     * Width of the result image (before any rotation)
+     *
      * @return integer
      */
     protected function _calculateWidth()
@@ -961,13 +969,15 @@ protected function _calculateWidth()
 
     /**
      * Calculate the width of the barcode
+     *
      * @return integer
      */
     abstract protected function _calculateBarcodeWidth();
 
     /**
      * Height of the result object
-     * @return integer
+     *
+     * @return int
      */
     protected function _calculateHeight()
     {
@@ -978,7 +988,8 @@ protected function _calculateHeight()
 
     /**
      * Height of the barcode
-     * @return integer
+     *
+     * @return int
      */
     protected function _calculateBarcodeHeight()
     {
@@ -993,7 +1004,9 @@ protected function _calculateBarcodeHeight()
 
     /**
      * Get height of the result object
-     * @return integer
+     *
+     * @param bool $recalculate
+     * @return int
      */
     public function getHeight($recalculate = false)
     {
@@ -1007,7 +1020,9 @@ public function getHeight($recalculate = false)
 
     /**
      * Get width of the result object
-     * @return integer
+     *
+     * @param bool $recalculate
+     * @return int
      */
     public function getWidth($recalculate = false)
     {
@@ -1022,7 +1037,8 @@ public function getWidth($recalculate = false)
     /**
      * Calculate the offset from the left of the object
      * if an orientation is activated
-     * @param boolean $recalculate
+     *
+     * @param bool $recalculate
      * @return float
      */
     public function getOffsetLeft($recalculate = false)
@@ -1049,7 +1065,8 @@ public function getOffsetLeft($recalculate = false)
     /**
      * Calculate the offset from the top of the object
      * if an orientation is activated
-     * @param boolean $recalculate
+     *
+     * @param bool $recalculate
      * @return float
      */
     public function getOffsetTop($recalculate = false)
@@ -1075,6 +1092,7 @@ public function getOffsetTop($recalculate = false)
 
     /**
      * Apply rotation on a point in X/Y dimensions
+     *
      * @param float $x1     x-position before rotation
      * @param float $y1     y-position before rotation
      * @return array        Array of two elements corresponding to the new XY point
@@ -1092,6 +1110,7 @@ protected function _rotate($x1, $y1)
 
     /**
      * Complete drawing of the barcode
+     *
      * @return array Table of instructions
      */
     public function draw()
@@ -1105,6 +1124,7 @@ public function draw()
 
     /**
      * Draw the barcode
+     *
      * @return void
      */
     protected function _drawBarcode()
@@ -1162,6 +1182,7 @@ protected function _drawBarcode()
 
     /**
      * Partial function to draw border
+     *
      * @return void
      */
     protected function _drawBorder()
@@ -1241,8 +1262,10 @@ public function validateText($value)
 
     /**
      * Standard validation for most of barcode objects
+     *
      * @param string $value
      * @param array  $options
+     * @throws Zend_Barcode_Object_Exception
      */
     protected function _validateText($value, $options = array())
     {