fixed a lot of phpDoc comments

yalibaba · Aug 10, 2012 · a867793 · a867793
1 parent 22808d1
commit a867793
Show file tree

Hide file tree

Showing 48 changed files with 207 additions and 203 deletions.
diff --git a/library/Zend/Authentication/Storage/NonPersistent.php b/library/Zend/Authentication/Storage/NonPersistent.php
@@ -31,7 +31,6 @@ class NonPersistent implements StorageInterface
     /**
      * Returns true if and only if storage is empty
      *
-     * @throws Zend\Authentication\Storage\Exception If it is impossible to determine whether storage is empty
      * @return boolean
      */
     public function isEmpty()

diff --git a/library/Zend/Barcode/Object/AbstractObject.php b/library/Zend/Barcode/Object/AbstractObject.php
@@ -403,7 +403,7 @@ public function setForeColor($value)
 
     /**
      * Retrieve color of the barcode and text
-     * @return unknown
+     * @return integer
      */
     public function getForeColor()
     {
@@ -462,7 +462,7 @@ public function getWithBorder()
     /**
      * Activate/deactivate drawing of the quiet zones
      * @param boolean $value
-     * @return Zend\Barcode\AbstractObject
+     * @return AbstractObject
      */
     public function setWithQuietZones($value)
     {
@@ -944,6 +944,7 @@ protected function calculateBarcodeHeight()
 
     /**
      * Get height of the result object
+     * @param bool $recalculate
      * @return integer
      */
     public function getHeight($recalculate = false)
@@ -958,6 +959,7 @@ public function getHeight($recalculate = false)
 
     /**
      * Get width of the result object
+     * @param bool $recalculate
      * @return integer
      */
     public function getWidth($recalculate = false)

diff --git a/library/Zend/Barcode/Object/Error.php b/library/Zend/Barcode/Object/Error.php
@@ -39,6 +39,7 @@ public function getHeight($recalculate = false)
 
     /**
      * Width is forced
+     * @param bool $recalculate
      * @return integer
      */
     public function getWidth($recalculate = false)

diff --git a/library/Zend/Barcode/Object/ObjectInterface.php b/library/Zend/Barcode/Object/ObjectInterface.php
@@ -29,15 +29,15 @@ 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);
 
@@ -57,7 +57,7 @@ public function getType();
     /**
      * Set height of the barcode bar
      * @param integer $value
-     * @return Object\ObjectInterface
+     * @return ObjectInterface
      */
     public function setBarHeight($value);
 
@@ -70,7 +70,7 @@ public function getBarHeight();
     /**
      * Set thickness of thin bar
      * @param integer $value
-     * @return Object\ObjectInterface
+     * @return ObjectInterface
      */
     public function setBarThinWidth($value);
 
@@ -83,7 +83,7 @@ public function getBarThinWidth();
     /**
      * Set thickness of thick bar
      * @param integer $value
-     * @return Object\ObjectInterface
+     * @return ObjectInterface
      */
     public function setBarThickWidth($value);
 
@@ -97,7 +97,7 @@ public function getBarThickWidth();
      * Set factor applying to
      * thinBarWidth - thickBarWidth - barHeight - fontSize
      * @param integer $value
-     * @return Object\ObjectInterface
+     * @return ObjectInterface
      */
     public function setFactor($value);
 
@@ -111,20 +111,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);
 
@@ -137,7 +137,7 @@ public function getBackgroundColor();
     /**
      * Activate/deactivate drawing of the bar
      * @param boolean $value
-     * @return Object\ObjectInterface
+     * @return ObjectInterface
      */
     public function setWithBorder($value);
 
@@ -149,14 +149,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);
 
@@ -169,7 +169,7 @@ public function getOrientation();
     /**
      * Set text to encode
      * @param string $value
-     * @return Object\ObjectInterface
+     * @return ObjectInterface
      */
     public function setText($value);
 
@@ -194,7 +194,7 @@ public function getTextToDisplay();
     /**
      * Activate/deactivate drawing of text to encode
      * @param boolean $value
-     * @return Object\ObjectInterface
+     * @return ObjectInterface
      */
     public function setDrawText($value);
 
@@ -208,7 +208,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);
 
@@ -224,7 +224,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);
 
@@ -240,7 +240,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);
 
@@ -256,7 +256,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);
 
@@ -269,7 +269,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);
 
@@ -300,12 +300,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);

diff --git a/library/Zend/Cache/Storage/Plugin/IgnoreUserAbort.php b/library/Zend/Cache/Storage/Plugin/IgnoreUserAbort.php
@@ -31,7 +31,7 @@ class IgnoreUserAbort extends AbstractPlugin
     /**
      * The storage who activated ignore_user_abort.
      *
-     * @var null|Zend\Cache\Storage\StorageInterface
+     * @var null|\Zend\Cache\Storage\StorageInterface
      */
     protected $activatedTarget = null;
 

diff --git a/library/Zend/Cache/Storage/Plugin/PluginInterface.php b/library/Zend/Cache/Storage/Plugin/PluginInterface.php
@@ -22,8 +22,8 @@ interface PluginInterface extends ListenerAggregateInterface
     /**
      * Set options
      *
-     * @param  Plugin\PluginOptions $options
-     * @return Plugin
+     * @param  PluginOptions $options
+     * @return PluginInterface
      */
     public function setOptions(PluginOptions $options);
 

diff --git a/library/Zend/Cache/StorageFactory.php b/library/Zend/Cache/StorageFactory.php
@@ -183,9 +183,9 @@ public static function resetAdapterPluginManager()
     /**
      * Instantiate a storage plugin
      *
-     * @param string|Storage\Plugin                          $pluginName
+     * @param string|Storage\Plugin\PluginInterface     $pluginName
      * @param array|Traversable|Storage\Plugin\PluginOptions $options
-     * @return Storage\Plugin
+     * @return Storage\Plugin\PluginInterface
      * @throws Exception\RuntimeException
      */
     public static function pluginFactory($pluginName, $options = array())

diff --git a/library/Zend/Db/Metadata/Metadata.php b/library/Zend/Db/Metadata/Metadata.php
@@ -47,7 +47,7 @@ public function __construct(Adapter $adapter)
      * Create source from adapter
      *
      * @param  Adapter $adapter
-     * @return Source\InformationSchemaMetadata
+     * @return Source\AbstractSource
      */
     protected function createSourceFromAdapter(Adapter $adapter)
     {

diff --git a/library/Zend/Db/Metadata/Source/AbstractSource.php b/library/Zend/Db/Metadata/Source/AbstractSource.php
@@ -375,8 +375,7 @@ public function getConstraint($constraintName, $table, $schema = null)
      * @param  string $constraint
      * @param  string $table
      * @param  string $schema
-     * @param  string $database
-     * @return Object\ConstraintKeyObject
+     * @return array
      */
     public function getConstraintKeys($constraint, $table, $schema = null)
     {

diff --git a/library/Zend/Db/RowGateway/RowGateway.php b/library/Zend/Db/RowGateway/RowGateway.php
@@ -11,8 +11,6 @@
 namespace Zend\Db\RowGateway;
 
 use Zend\Db\Adapter\Adapter;
-use Zend\Db\ResultSet\Row;
-use Zend\Db\ResultSet\RowObjectInterface;
 use Zend\Db\Sql\Sql;
 
 /**
@@ -26,10 +24,9 @@ class RowGateway extends AbstractRowGateway
     /**
      * Constructor
      *
-     * @param string $tableGateway
+     * @param string $primaryKeyColumn
      * @param string|\Zend\Db\Sql\TableIdentifier $table
-     * @param Adapter $adapter
-     * @param Sql\Sql $sql
+     * @param Adapter|Sql $adapterOrSql
      */
     public function __construct($primaryKeyColumn, $table, $adapterOrSql = null)
     {

diff --git a/library/Zend/Db/Sql/Platform/AbstractPlatform.php b/library/Zend/Db/Sql/Platform/AbstractPlatform.php
@@ -15,6 +15,7 @@
 use Zend\Db\Adapter\Platform\PlatformInterface;
 use Zend\Db\Sql\PreparableSqlInterface;
 use Zend\Db\Sql\SqlInterface;
+use Zend\Db\Sql\Exception;
 
 class AbstractPlatform implements PlatformDecoratorInterface, PreparableSqlInterface, SqlInterface
 {
@@ -55,7 +56,7 @@ public function getDecorators()
 
     /**
      * @param Adapter $adapter
-     * @return StatementInterface
+     * @param StatementInterface $statement
      */
     public function prepareStatement(Adapter $adapter, StatementInterface $statement)
     {

diff --git a/library/Zend/Db/TableGateway/AbstractTableGateway.php b/library/Zend/Db/TableGateway/AbstractTableGateway.php
@@ -63,7 +63,7 @@ abstract class AbstractTableGateway implements TableGatewayInterface
     protected $resultSetPrototype = null;
 
     /**
-     * @var Sql\Sql
+     * @var Sql
      */
     protected $sql = null;
 
@@ -198,7 +198,7 @@ public function select($where = null)
     }
 
     /**
-     * @param Sql\Select $select
+     * @param Select $select
      * @return null|ResultSetInterface
      * @throws \RuntimeException
      */

diff --git a/library/Zend/Feed/Reader/AbstractEntry.php b/library/Zend/Feed/Reader/AbstractEntry.php
@@ -37,7 +37,7 @@ abstract class AbstractEntry
     /**
      * Entry instance
      *
-     * @var Zend\Feed\Entry
+     * @var DOMElement
      */
     protected $entry = null;
 
@@ -67,7 +67,7 @@ abstract class AbstractEntry
      *
      * @param  DOMElement $entry
      * @param  int $entryKey
-     * @param  string $type
+     * @param  null|string $type
      * @return void
      */
     public function __construct(DOMElement $entry, $entryKey, $type = null)
@@ -78,7 +78,7 @@ public function __construct(DOMElement $entry, $entryKey, $type = null)
         if ($type !== null) {
             $this->data['type'] = $type;
         } else {
-            $this->data['type'] = Reader::detectType($feed);
+            $this->data['type'] = Reader::detectType($entry);
         }
         $this->_loadExtensions();
     }
@@ -157,7 +157,7 @@ public function getXpath()
      * Set the XPath query
      *
      * @param  DOMXPath $xpath
-     * @return Zend\Feed\Reader\AbstractEntry
+     * @return \Zend\Feed\Reader\AbstractEntry
      */
     public function setXpath(DOMXPath $xpath)
     {

diff --git a/library/Zend/Feed/Reader/AbstractFeed.php b/library/Zend/Feed/Reader/AbstractFeed.php
@@ -127,7 +127,7 @@ public function count()
     /**
      * Return the current entry
      *
-     * @return \Zend\Feed\Reader\Entry
+     * @return \Zend\Feed\Reader\AbstractEntry
      */
     public function current()
     {