Fixes DocBlocks in Zend_Barcode_Object_ObjectAbstract

library/Zend/Barcode/Object/ObjectAbstract.php

@@ -32,48 +32,56 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 {
     /**
      * Namespace of the barcode for autoloading
+     *
      * @var string
      */
     protected $_barcodeNamespace = 'Zend_Barcode_Object';
 
     /**
      * Set of drawing instructions
+     *
      * @var array
      */
     protected $_instructions = array();
 
     /**
      * Barcode type
+     *
      * @var string
      */
     protected $_type = null;
 
     /**
      * Height of the object
+     *
      * @var integer
      */
     protected $_height = null;
 
     /**
      * Width of the object
+     *
      * @var integer
      */
     protected $_width = null;
 
     /**
      * Height of the bar
+     *
      * @var integer
      */
     protected $_barHeight = 50;
 
     /**
      * Width of a thin bar
+     *
      * @var integer
      */
     protected $_barThinWidth = 1;
 
     /**
      * Width of a thick bar
+     *
      * @var integer
      */
     protected $_barThickWidth = 3;
@@ -81,42 +89,49 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Factor to multiply bar and font measure
      * (barHeight, barThinWidth, barThickWidth & fontSize)
+     *
      * @var integer
      */
     protected $_factor = 1;
 
     /**
      * Font and bars color of the object
+     *
      * @var integer
      */
     protected $_foreColor = 0x000000;
 
     /**
      * Background color of the object
+     *
      * @var integer
      */
     protected $_backgroundColor = 0xFFFFFF;
 
     /**
      * Activate/deactivate border of the object
+     *
      * @var boolean
      */
     protected $_withBorder = false;
 
     /**
      * Activate/deactivate drawing of quiet zones
+     *
      * @var boolean
      */
     protected $_withQuietZones = true;
 
     /**
      * Force quiet zones even if
+     *
      * @var boolean
      */
     protected $_mandatoryQuietZones = false;
 
     /**
      * Orientation of the barcode in degrees
+     *
      * @var float
      */
     protected $_orientation = 0;
@@ -124,6 +139,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Offset from the top the object
      * (calculated from the orientation)
+     *
      * @var integer
      */
     protected $_offsetTop = null;
@@ -131,24 +147,28 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Offset from the left the object
      * (calculated from the orientation)
+     *
      * @var integer
      */
     protected $_offsetLeft = null;
 
     /**
      * Text to display
+     *
      * @var string
      */
     protected $_text = null;
 
     /**
      * Display (or not) human readable text
+     *
      * @var boolean
      */
     protected $_drawText = true;
 
     /**
      * Adjust (or not) position of human readable characters with barcode
+     *
      * @var boolean
      */
     protected $_stretchText = false;
@@ -157,30 +177,35 @@ abstract class Zend_Barcode_Object_ObjectAbstract
      * Font resource
      *  - integer (1 to 5): corresponds to GD included fonts
      *  - string: corresponds to path of a TTF font
+     *
      * @var integer|string
      */
     protected $_font = null;
 
     /**
      * Font size
+     *
      * @var float
      */
     protected $_fontSize = 10;
 
     /**
      * Drawing of checksum
+     *
      * @var boolean
      */
     protected $_withChecksum = false;
 
     /**
      * Drawing of checksum inside text
+     *
      * @var boolean
      */
     protected $_withChecksumInText = false;
 
     /**
      * Fix barcode length (numeric or string like 'even')
+     *
      * @var $_barcodeLength integer | string
      */
     protected $_barcodeLength = null;
@@ -188,6 +213,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Activate automatic addition of leading zeros
      * if barcode length is fixed
+     *
      * @var $_addLeadingZeros boolean
      */
     protected $_addLeadingZeros = true;
@@ -195,18 +221,21 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Activation of mandatory checksum
      * to deactivate unauthorized modification
+     *
      * @var $_mandatoryChecksum boolean
      */
     protected $_mandatoryChecksum = false;
 
     /**
      * Character used to substitute checksum character for validation
+     *
      * @var $_substituteChecksumCharacter mixed
      */
     protected $_substituteChecksumCharacter = 0;
 
     /**
      * TTF font name: can be set before instanciation of the object
+     *
      * @var string
      */
     protected static $_staticFont = null;
@@ -237,7 +266,6 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set default options for particular object
-     * @return void
      */
     protected function _getDefaultOptions()
     {
@@ -245,8 +273,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set barcode state from options array
+     *
      * @param  array $options
-     * @return Zend_Barcode_Object
+     * @return $this
      */
     public function setOptions($options)
     {
@@ -261,8 +290,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set barcode state from config object
+     *
      * @param Zend_Config $config
-     * @return Zend_Barcode_Object
+     * @return $this
      */
     public function setConfig(Zend_Config $config)
     {
@@ -273,7 +303,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
      * Set barcode namespace for autoloading
      *
      * @param string $namespace
-     * @return Zend_Barcode_Object
+     * @return $this
      */
     public function setBarcodeNamespace($namespace)
     {
@@ -293,6 +323,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve type of barcode
+     *
      * @return string
      */
     public function getType()
@@ -302,8 +333,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set height of the barcode bar
+     *
      * @param integer $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setBarHeight($value)
@@ -320,6 +352,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Get height of the barcode bar
+     *
      * @return integer
      */
     public function getBarHeight()
@@ -329,8 +362,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set thickness of thin bar
+     *
      * @param integer $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setBarThinWidth($value)
@@ -347,6 +381,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Get thickness of thin bar
+     *
      * @return integer
      */
     public function getBarThinWidth()
@@ -356,8 +391,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set thickness of thick bar
+     *
      * @param integer $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setBarThickWidth($value)
@@ -374,6 +410,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Get thickness of thick bar
+     *
      * @return integer
      */
     public function getBarThickWidth()
@@ -384,8 +421,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Set factor applying to
      * thinBarWidth - thickBarWidth - barHeight - fontSize
-     * @param float $value
-     * @return Zend_Barcode_Object
+     *
+     * @param int|float|string|bool $value
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setFactor($value)
@@ -403,6 +441,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Get factor applying to
      * thinBarWidth - thickBarWidth - barHeight - fontSize
+     *
      * @return integer
      */
     public function getFactor()
@@ -412,8 +451,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set color of the barcode and text
+     *
      * @param string $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setForeColor($value)
@@ -433,6 +473,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve color of the barcode and text
+     *
      * @return unknown
      */
     public function getForeColor()
@@ -442,8 +483,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set the color of the background
+     *
      * @param integer $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setBackgroundColor($value)
@@ -463,6 +505,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve background color of the image
+     *
      * @return integer
      */
     public function getBackgroundColor()
@@ -472,8 +515,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Activate/deactivate drawing of the bar
+     *
      * @param boolean $value
-     * @return Zend_Barcode_Object
+     * @return $this
      */
     public function setWithBorder($value)
     {
@@ -483,6 +527,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve if border are draw or not
+     *
      * @return boolean
      */
     public function getWithBorder()
@@ -492,8 +537,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Activate/deactivate drawing of the quiet zones
+     *
      * @param boolean $value
-     * @return Zend_Barcode_Object
+     * @return $this
      */
     public function setWithQuietZones($value)
     {
@@ -503,6 +549,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve if quiet zones are draw or not
+     *
      * @return boolean
      */
     public function getWithQuietZones()
@@ -512,20 +559,23 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Allow fast inversion of font/bars color and background color
-     * @return Zend_Barcode_Object
+     *
+     * @return $this
      */
     public function setReverseColor()
     {
         $tmp                    = $this->_foreColor;
         $this->_foreColor       = $this->_backgroundColor;
         $this->_backgroundColor = $tmp;
+
         return $this;
     }
 
     /**
      * Set orientation of barcode and text
-     * @param float $value
-     * @return Zend_Barcode_Object
+     *
+     * @param int|float|string|bool $value
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setOrientation($value)
@@ -536,6 +586,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve orientation of barcode and text
+     *
      * @return float
      */
     public function getOrientation()
@@ -545,8 +596,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set text to encode
+     *
      * @param string $value
-     * @return Zend_Barcode_Object
+     * @return $this
      */
     public function setText($value)
     {
@@ -556,6 +608,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve text to encode
+     *
      * @return string
      */
     public function getText()
@@ -594,6 +647,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve text to encode
+     *
      * @return string
      */
     public function getRawText()
@@ -603,6 +657,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve text to display
+     *
      * @return string
      */
     public function getTextToDisplay()
@@ -616,8 +671,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Activate/deactivate drawing of text to encode
+     *
      * @param boolean $value
-     * @return Zend_Barcode_Object
+     * @return $this
      */
     public function setDrawText($value)
     {
@@ -627,6 +683,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve if drawing of text to encode is enabled
+     *
      * @return boolean
      */
     public function getDrawText()
@@ -637,8 +694,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Activate/deactivate the adjustment of the position
      * of the characters to the position of the bars
+     *
      * @param boolean $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setStretchText($value)
@@ -650,6 +708,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Retrieve if the adjustment of the position of the characters
      * to the position of the bars is enabled
+     *
      * @return boolean
      */
     public function getStretchText()
@@ -661,8 +720,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
      * Activate/deactivate the automatic generation
      * of the checksum character
      * added to the barcode text
+     *
      * @param boolean $value
-     * @return Zend_Barcode_Object
+     * @return $this
      */
     public function setWithChecksum($value)
     {
@@ -675,6 +735,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Retrieve if the checksum character is automatically
      * added to the barcode text
+     *
      * @return boolean
      */
     public function getWithChecksum()
@@ -686,8 +747,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
      * Activate/deactivate the automatic generation
      * of the checksum character
      * added to the barcode text
+     *
      * @param boolean $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setWithChecksumInText($value)
@@ -695,12 +757,14 @@ abstract class Zend_Barcode_Object_ObjectAbstract
         if (!$this->_mandatoryChecksum) {
             $this->_withChecksumInText = (bool) $value;
         }
+
         return $this;
     }
 
     /**
      * Retrieve if the checksum character is automatically
      * added to the barcode text
+     *
      * @return boolean
      */
     public function getWithChecksumInText()
@@ -710,8 +774,8 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set the font for all instances of barcode
+     *
      * @param string $font
-     * @return void
      */
     public static function setBarcodeFont($font)
     {
@@ -724,8 +788,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
      * Set the font:
      *  - if integer between 1 and 5, use gd built-in fonts
      *  - if string, $value is assumed to be the path to a TTF font
+     *
      * @param integer|string $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setFont($value)
@@ -757,6 +822,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve the font
+     *
      * @return integer|string
      */
     public function getFont()
@@ -766,8 +832,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Set the size of the font in case of TTF
+     *
      * @param float $value
-     * @return Zend_Barcode_Object
+     * @return $this
      * @throws Zend_Barcode_Object_Exception
      */
     public function setFontSize($value)
@@ -790,6 +857,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve the size of the font in case of TTF
+     *
      * @return float
      */
     public function getFontSize()
@@ -800,6 +868,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Quiet zone before first bar
      * and after the last bar
+     *
      * @return integer
      */
     public function getQuietZone()
@@ -813,6 +882,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Add an instruction in the array of instructions
+     *
      * @param array $instruction
      */
     protected function _addInstruction(array $instruction)
@@ -822,6 +892,7 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Retrieve the set of drawing instructions
+     *
      * @return array
      */
     public function getInstructions()
@@ -831,7 +902,8 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Add a polygon drawing instruction in the set of instructions
-     * @param array $points
+     *
+     * @param array   $points
      * @param integer $color
      * @param boolean $filled
      */
@@ -900,7 +972,6 @@ abstract class Zend_Barcode_Object_ObjectAbstract
      * Check if a text is really provided to barcode
      *
      * @param string|null $value
-     * @return void
      * @throws Zend_Barcode_Object_Exception
      */
     protected function _checkText($value = null)
@@ -922,7 +993,6 @@ abstract class Zend_Barcode_Object_ObjectAbstract
      *
      * @param int $min
      * @param int $max
-     * @return void
      * @throws Zend_Barcode_Object_Exception
      */
     protected function _checkRatio($min = 2, $max = 3)
@@ -942,7 +1012,6 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Drawing with an angle is just allow TTF font
      *
-     * @return void
      * @throws Zend_Barcode_Object_Exception
      */
     protected function _checkFontAndOrientation()
@@ -1093,9 +1162,9 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * 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
+     * @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
      */
     protected function _rotate($x1, $y1)
     {
@@ -1124,8 +1193,6 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Draw the barcode
-     *
-     * @return void
      */
     protected function _drawBarcode()
     {
@@ -1182,8 +1249,6 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Partial function to draw border
-     *
-     * @return void
      */
     protected function _drawBorder()
     {
@@ -1207,7 +1272,6 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Partial function to draw text
-     * @return void
      */
     protected function _drawText()
     {
@@ -1252,8 +1316,8 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Check for invalid characters
-     * @param   string $value    Text to be ckecked
-     * @return void
+     *
+     * @param string $value Text to be ckecked
      */
     public function validateText($value)
     {
@@ -1314,15 +1378,11 @@ abstract class Zend_Barcode_Object_ObjectAbstract
 
     /**
      * Checking of parameters after all settings
-     *
-     * @return void
      */
     abstract protected function _checkParams();
 
     /**
      * Allow each child to draw something else
-     *
-     * @return void
      */
     protected function _preDrawBarcode()
     {
@@ -1331,8 +1391,6 @@ abstract class Zend_Barcode_Object_ObjectAbstract
     /**
      * Allow each child to draw something else
      * (ex: bearer bars in interleaved 2 of 5 code)
-     *
-     * @return void
      */
     protected function _postDrawBarcode()
     {