Skip to content
This repository has been archived by the owner on Jan 29, 2020. It is now read-only.

Commit

Permalink
Merge pull request zendframework/zendframework#2144 from PHPGangsta/f…
Browse files Browse the repository at this point in the history
…ixes/phpdocClassesAndNamespaces

fixed a lot of phpDoc comments
  • Loading branch information
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 25 deletions.
7 changes: 4 additions & 3 deletions src/Object/AbstractObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,6 @@ abstract class AbstractObject implements ObjectInterface
/**
* Constructor
* @param array|Traversable $options
* @return void
*/
public function __construct($options = null)
{
Expand Down Expand Up @@ -403,7 +402,7 @@ public function setForeColor($value)

/**
* Retrieve color of the barcode and text
* @return unknown
* @return integer
*/
public function getForeColor()
{
Expand Down Expand Up @@ -462,7 +461,7 @@ public function getWithBorder()
/**
* Activate/deactivate drawing of the quiet zones
* @param boolean $value
* @return Zend\Barcode\AbstractObject
* @return AbstractObject
*/
public function setWithQuietZones($value)
{
Expand Down Expand Up @@ -944,6 +943,7 @@ protected function calculateBarcodeHeight()

/**
* Get height of the result object
* @param bool $recalculate
* @return integer
*/
public function getHeight($recalculate = false)
Expand All @@ -958,6 +958,7 @@ public function getHeight($recalculate = false)

/**
* Get width of the result object
* @param bool $recalculate
* @return integer
*/
public function getWidth($recalculate = false)
Expand Down
1 change: 1 addition & 0 deletions src/Object/Error.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ public function getHeight($recalculate = false)

/**
* Width is forced
* @param bool $recalculate
* @return integer
*/
public function getWidth($recalculate = false)
Expand Down
41 changes: 21 additions & 20 deletions src/Object/ObjectInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,21 @@ interface ObjectInterface
/**
* Constructor
* @param array|\Traversable $options
* @return void
*/
public function __construct($options = null);

/**
* Set barcode state from options array
* @param array $options
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setOptions($options);

/**
* Set barcode namespace for autoloading
*
* @param string $namespace
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setBarcodeNamespace($namespace);

Expand All @@ -57,7 +56,7 @@ public function getType();
/**
* Set height of the barcode bar
* @param integer $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setBarHeight($value);

Expand All @@ -70,7 +69,7 @@ public function getBarHeight();
/**
* Set thickness of thin bar
* @param integer $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setBarThinWidth($value);

Expand All @@ -83,7 +82,7 @@ public function getBarThinWidth();
/**
* Set thickness of thick bar
* @param integer $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setBarThickWidth($value);

Expand All @@ -97,7 +96,7 @@ public function getBarThickWidth();
* Set factor applying to
* thinBarWidth - thickBarWidth - barHeight - fontSize
* @param integer $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setFactor($value);

Expand All @@ -111,20 +110,20 @@ public function getFactor();
/**
* Set color of the barcode and text
* @param string $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setForeColor($value);

/**
* Retrieve color of the barcode and text
* @return unknown
* @return integer
*/
public function getForeColor();

/**
* Set the color of the background
* @param integer $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setBackgroundColor($value);

Expand All @@ -137,7 +136,7 @@ public function getBackgroundColor();
/**
* Activate/deactivate drawing of the bar
* @param boolean $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setWithBorder($value);

Expand All @@ -149,14 +148,14 @@ public function getWithBorder();

/**
* Allow fast inversion of font/bars color and background color
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setReverseColor();

/**
* Set orientation of barcode and text
* @param float $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setOrientation($value);

Expand All @@ -169,7 +168,7 @@ public function getOrientation();
/**
* Set text to encode
* @param string $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setText($value);

Expand All @@ -194,7 +193,7 @@ public function getTextToDisplay();
/**
* Activate/deactivate drawing of text to encode
* @param boolean $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setDrawText($value);

Expand All @@ -208,7 +207,7 @@ public function getDrawText();
* Activate/deactivate the adjustment of the position
* of the characters to the position of the bars
* @param boolean $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setStretchText($value);

Expand All @@ -224,7 +223,7 @@ public function getStretchText();
* of the checksum character
* added to the barcode text
* @param boolean $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setWithChecksum($value);

Expand All @@ -240,7 +239,7 @@ public function getWithChecksum();
* of the checksum character
* added to the barcode text
* @param boolean $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setWithChecksumInText($value);

Expand All @@ -256,7 +255,7 @@ public function getWithChecksumInText();
* - 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 Object\ObjectInterface
* @return ObjectInterface
*/
public function setFont($value);

Expand All @@ -269,7 +268,7 @@ public function getFont();
/**
* Set the size of the font in case of TTF
* @param float $value
* @return Object\ObjectInterface
* @return ObjectInterface
*/
public function setFontSize($value);

Expand Down Expand Up @@ -300,12 +299,14 @@ public function checkParams();

/**
* Get height of the result object
* @param boolean $recalculate
* @return integer
*/
public function getHeight($recalculate = false);

/**
* Get width of the result object
* @param boolean $recalculate
* @return integer
*/
public function getWidth($recalculate = false);
Expand Down
1 change: 0 additions & 1 deletion src/Renderer/AbstractRenderer.php
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ abstract class AbstractRenderer implements RendererInterface
/**
* Constructor
* @param array|Traversable $options
* @return void
*/
public function __construct($options = null)
{
Expand Down
1 change: 0 additions & 1 deletion src/Renderer/RendererInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ interface RendererInterface
/**
* Constructor
* @param array|\Traversable $options
* @return void
*/
public function __construct($options = null);

Expand Down

0 comments on commit c127652

Please sign in to comment.