[ZF-10805]: method docblocks contain invalid @param syntax

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@23650 44c647ce-9c0f-0410-b52a-842ac1e357ba

bin/zf.php

@@ -157,8 +157,8 @@ class ZF
     /**
      * _detectHomeDirectory() - detect the home directory in a variety of different places
      * 
-     * @param $mustExist Should the returned value already exist in the file system
-     * @param $returnMessages Should it log messages for output later
+     * @param bool $mustExist Should the returned value already exist in the file system
+     * @param bool $returnMessages Should it log messages for output later
      * @return string
      */
     protected function _detectHomeDirectory($mustExist = true, $returnMessages = true)
@@ -215,8 +215,8 @@ class ZF
     /**
      * _detectStorageDirectory() - Detect where the storage directory is from a variaty of possiblities
      * 
-     * @param $mustExist Should the returned value already exist in the file system
-     * @param $returnMessages Should it log messages for output later
+     * @param bool $mustExist Should the returned value already exist in the file system
+     * @param bool $returnMessages Should it log messages for output later
      * @return string
      */
     protected function _detectStorageDirectory($mustExist = true, $returnMessages = true)
@@ -251,8 +251,8 @@ class ZF
     /**
      * _detectConfigFile() - Detect config file location from a variety of possibilities
      * 
-     * @param $mustExist Should the returned value already exist in the file system
-     * @param $returnMessages Should it log messages for output later
+     * @param bool $mustExist Should the returned value already exist in the file system
+     * @param bool $returnMessages Should it log messages for output later
      * @return string
      */
     protected function _detectConfigFile($mustExist = true, $returnMessages = true)
@@ -602,8 +602,8 @@ EOS;
     /**
      * _logMessage() - Internal method used to log setup and information messages.
      * 
-     * @param $message
-     * @param $storeMessage
+     * @param string $message
+     * @param bool   $storeMessage
      * @return void
      */
     protected function _logMessage($message, $storeMessage = true)

demos/Zend/Service/LiveDocx/MailMerge/license-agreement/generate-document-concat.php

@@ -149,7 +149,6 @@ if (is_dir($tempDirectory)) {
 /**
  * Create a random string
  * 
- * @param $length
  * @return string
  */
 function randomString()
@@ -172,7 +171,7 @@ function randomString()
 /**
  * Recursively remove directory
  * 
- * @param $dir
+ * @param string $dir
  * @return void
  */
 function recursiveRemoveDirectory($dir)
@@ -197,9 +196,9 @@ function recursiveRemoveDirectory($dir)
  * $outputFilename, using concatenation processor (external 3rd party command
  * line tool) specified in $processor
  * 
- * @param $inputFilenames
- * @param $outputFilename
- * @param $processor
+ * @param array  $inputFilenames
+ * @param array  $outputFilename
+ * @param string $processor
  * @return boolean
  */
 function concatenatePdfFilenames($inputFilenames, $outputFilename, $processor = EXEC_PDFTK)
@@ -248,4 +247,4 @@ function concatenatePdfFilenames($inputFilenames, $outputFilename, $processor =
     }
 
     return $ret;        
-}
+}

demos/Zend/Service/LiveDocx/check-environment.php

@@ -259,9 +259,10 @@ print(Demos_Zend_Service_LiveDocx_Helper::wrapLine(PHP_EOL . $message . PHP_EOL
 /**
  * Print result line
  *
- * @param $counter
- * @param $testString
- * @param $testResult
+ * @param int    $counter
+ * @param string $testString
+ * @param mixed  $testResult
+ * @return void
  */
 function printLine($counter, $testString, $testResult)
 {

library/Zend/Amf/Parse/Amf0/Serializer.php

@@ -187,9 +187,9 @@ class Zend_Amf_Parse_Amf0_Serializer extends Zend_Amf_Parse_Serializer
      * Check if the given object is in the reference table, write the reference if it exists,
      * otherwise add the object to the reference table
      *
-     * @param mixed $object object reference to check for reference
-     * @param $markerType AMF type of the object to write
-     * @param mixed $objectByVal object to check for reference
+     * @param mixed  $object object reference to check for reference
+     * @param string $markerType AMF type of the object to write
+     * @param mixed  $objectByVal object to check for reference
      * @return Boolean true, if the reference was written, false otherwise
      */
     protected function writeObjectReference(&$object, $markerType, $objectByVal = false)

library/Zend/Application/Resource/Db.php

@@ -66,7 +66,7 @@ class Zend_Application_Resource_Db extends Zend_Application_Resource_ResourceAbs
     /**
      * Set the adapter
      *
-     * @param  $adapter string
+     * @param  string $adapter
      * @return Zend_Application_Resource_Db
      */
     public function setAdapter($adapter)
@@ -88,7 +88,7 @@ class Zend_Application_Resource_Db extends Zend_Application_Resource_ResourceAbs
     /**
      * Set the adapter params
      *
-     * @param  $adapter string
+     * @param  string $adapter
      * @return Zend_Application_Resource_Db
      */
     public function setParams(array $params)

library/Zend/Barcode/Object/Code128.php

@@ -238,9 +238,9 @@ class Zend_Barcode_Object_Code128 extends Zend_Barcode_Object_ObjectAbstract
     /**
      * Checks if the next $length chars of $string starting at $pos are numeric.
      * Returns false if the end of the string is reached.
-     * @param $string String to search
-     * @param $pos Starting position
-     * @param $length Length to search
+     * @param string $string String to search
+     * @param int    $pos Starting position
+     * @param int    $length Length to search
      * @return bool
      */
     protected static function _isDigit($string, $pos, $length = 2)
@@ -388,4 +388,4 @@ class Zend_Barcode_Object_Code128 extends Zend_Barcode_Object_ObjectAbstract
         // @TODO: add code128 validator
         return true;
     }
-}
+}

library/Zend/Cache/Backend.php

@@ -200,7 +200,7 @@ class Zend_Cache_Backend
     /**
      * Verify if the given temporary directory is readable and writable
      *
-     * @param $dir temporary directory
+     * @param string $dir temporary directory
      * @return boolean true if the directory is ok
      */
     protected function _isGoodTmpDir($dir)

library/Zend/Cache/Backend/Static.php

@@ -540,7 +540,7 @@ class Zend_Cache_Backend_Static
      * Detect an octal string and return its octal value for file permission ops
      * otherwise return the non-string (assumed octal or decimal int already)
      *
-     * @param $val The potential octal in need of conversion
+     * @param string $val The potential octal in need of conversion
      * @return int
      */
     protected function _octdec($val)

library/Zend/Captcha/Word.php

@@ -220,7 +220,7 @@ abstract class Zend_Captcha_Word extends Zend_Captcha_Base
     /**
      * Sets if session should be preserved on generate()
      *
-     * @param $keepSession Should session be kept on generate()?
+     * @param bool $keepSession Should session be kept on generate()?
      * @return Zend_Captcha_Word
      */
     public function setKeepSession($keepSession)
@@ -242,7 +242,7 @@ abstract class Zend_Captcha_Word extends Zend_Captcha_Base
     /**
      * Set if numbers should be included in the pattern
      *
-     * @param $_useNumbers numbers should be included in the pattern?
+     * @param bool $_useNumbers numbers should be included in the pattern?
      * @return Zend_Captcha_Word
      */
     public function setUseNumbers($_useNumbers)

library/Zend/Cloud/QueueService/Message.php

@@ -33,7 +33,7 @@ class Zend_Cloud_QueueService_Message
 
     /**
      * @param string $body Message text
-     * @param $message Original message
+     * @param string $message Original message
      */
     function __construct($body, $message)
     {

library/Zend/Cloud/StorageService/Adapter/Nirvanix.php

@@ -244,9 +244,9 @@ class Zend_Cloud_StorageService_Adapter_Nirvanix
      * WARNING: This operation overwrites any metadata that is located at
      * $destinationPath.
      *
-     * @param array $metadata - An associative array specifying the key/value pairs for the metadata.
-     * @param $destinationPath
-     * @param  array $options
+     * @param string $destinationPath
+     * @param array  $metadata        associative array specifying the key/value pairs for the metadata.
+     * @param array  $options
      * @return void
      */
     public function storeMetadata($destinationPath, $metadata, $options = null)
@@ -300,9 +300,9 @@ class Zend_Cloud_StorageService_Adapter_Nirvanix
      * Recursively traverse all the folders and build an array that contains
      * the path names for each folder.
      *
-     * @param $path - The folder path to get the list of folders from.
-     * @param &$resultArray - reference to the array that contains the path names
-     *                           for each folder.
+     * @param string $path        folder path to get the list of folders from.
+     * @param array& $resultArray reference to the array that contains the path names
+     *                             for each folder.
      */
     private function getAllFolders($path, &$resultArray)
     {

library/Zend/Config/Writer/Yaml.php

@@ -57,7 +57,7 @@ class Zend_Config_Writer_Yaml extends Zend_Config_Writer_FileAbstract
     /**
      * Set callback for decoding YAML
      *
-     * @param  $yamlEncoder the decoder to set
+     * @param  callable $yamlEncoder the decoder to set
      * @return Zend_Config_Yaml
      */
     public function setYamlEncoder($yamlEncoder)

library/Zend/Config/Yaml.php

@@ -93,7 +93,7 @@ class Zend_Config_Yaml extends Zend_Config
     /**
      * Set callback for decoding YAML
      *
-     * @param  $yamlDecoder the decoder to set
+     * @param  callable $yamlDecoder the decoder to set
      * @return Zend_Config_Yaml
      */
     public function setYamlDecoder($yamlDecoder)

library/Zend/Date.php

@@ -3238,7 +3238,7 @@ class Zend_Date extends Zend_Date_DateObject
     /**
      * Check if location is supported
      *
-     * @param $location array - locations array
+     * @param array $location locations array
      * @return $horizon float
      */
     private function _checkLocation($location)
@@ -3281,7 +3281,7 @@ class Zend_Date extends Zend_Date_DateObject
      * Returns the time of sunrise for this date and a given location as new date object
      * For a list of cities and correct locations use the class Zend_Date_Cities
      *
-     * @param  $location array - location of sunrise
+     * @param array $location location of sunrise
      *                   ['horizon']   -> civil, nautic, astronomical, effective (default)
      *                   ['longitude'] -> longitude of location
      *                   ['latitude']  -> latitude of location
@@ -3301,7 +3301,7 @@ class Zend_Date extends Zend_Date_DateObject
      * Returns the time of sunset for this date and a given location as new date object
      * For a list of cities and correct locations use the class Zend_Date_Cities
      *
-     * @param  $location array - location of sunset
+     * @param array $location location of sunset
      *                   ['horizon']   -> civil, nautic, astronomical, effective (default)
      *                   ['longitude'] -> longitude of location
      *                   ['latitude']  -> latitude of location
@@ -3321,7 +3321,7 @@ class Zend_Date extends Zend_Date_DateObject
      * Returns an array with the sunset and sunrise dates for all horizon types
      * For a list of cities and correct locations use the class Zend_Date_Cities
      *
-     * @param  $location array - location of suninfo
+     * @param array $location location of suninfo
      *                   ['horizon']   -> civil, nautic, astronomical, effective (default)
      *                   ['longitude'] -> longitude of location
      *                   ['latitude']  -> latitude of location
@@ -3786,7 +3786,7 @@ class Zend_Date extends Zend_Date_DateObject
      * Returns the day as new date object
      * Example: 20.May.1986 -> 20.Jan.1970 00:00:00
      *
-     * @param $locale  string|Zend_Locale  OPTIONAL Locale for parsing input
+     * @param Zend_Locale $locale OPTIONAL Locale for parsing input
      * @return Zend_Date
      */
     public function getDay($locale = null)
@@ -3798,9 +3798,9 @@ class Zend_Date extends Zend_Date_DateObject
     /**
      * Returns the calculated day
      *
-     * @param $calc    string                    Type of calculation to make
-     * @param $day     string|integer|Zend_Date  Day to calculate, when null the actual day is calculated
-     * @param $locale  string|Zend_Locale        Locale for parsing input
+     * @param string      $calc    Type of calculation to make
+     * @param Zend_Date   $day     Day to calculate, when null the actual day is calculated
+     * @param Zend_Locale $locale  Locale for parsing input
      * @return Zend_Date|integer
      */
     private function _day($calc, $day, $locale)
@@ -3929,7 +3929,7 @@ class Zend_Date extends Zend_Date_DateObject
      * Weekday is always from 1-7
      * Example: 09-Jan-2007 -> 2 = Tuesday -> 02-Jan-1970 (when 02.01.1970 is also Tuesday)
      *
-     * @param $locale  string|Zend_Locale  OPTIONAL Locale for parsing input
+     * @param Zend_Locale $locale OPTIONAL Locale for parsing input
      * @return Zend_Date
      */
     public function getWeekday($locale = null)
@@ -3947,9 +3947,9 @@ class Zend_Date extends Zend_Date_DateObject
     /**
      * Returns the calculated weekday
      *
-     * @param  $calc     string                          Type of calculation to make
-     * @param  $weekday  string|integer|array|Zend_Date  Weekday to calculate, when null the actual weekday is calculated
-     * @param  $locale   string|Zend_Locale              Locale for parsing input
+     * @param  string      $calc     Type of calculation to make
+     * @param  Zend_Date   $weekday  Weekday to calculate, when null the actual weekday is calculated
+     * @param  Zend_Locale $locale   Locale for parsing input
      * @return Zend_Date|integer
      * @throws Zend_Date_Exception
      */
@@ -4166,7 +4166,7 @@ class Zend_Date extends Zend_Date_DateObject
      * Returns the hour as new date object
      * Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 10:00:00
      *
-     * @param $locale  string|Zend_Locale  OPTIONAL Locale for parsing input
+     * @param Zend_Locale $locale OPTIONAL Locale for parsing input
      * @return Zend_Date
      */
     public function getHour($locale = null)
@@ -4617,7 +4617,7 @@ class Zend_Date extends Zend_Date_DateObject
      * Returns the week as new date object using monday as begining of the week
      * Example: 12.Jan.2007 -> 08.Jan.1970 00:00:00
      *
-     * @param $locale  string|Zend_Locale  OPTIONAL Locale for parsing input
+     * @param Zend_Locale $locale OPTIONAL Locale for parsing input
      * @return Zend_Date
      */
     public function getWeek($locale = null)

library/Zend/Feed/Writer/Feed.php

@@ -258,7 +258,8 @@ implements Iterator, Countable
     /**
      * Attempt to build and return the feed resulting from the data set
      *
-     * @param $type The feed type "rss" or "atom" to export as
+     * @param string $type             The feed type "rss" or "atom" to export as
+		 * @param bool   $ignoreExceptions
      * @return string
      */
     public function export($type, $ignoreExceptions = false)

library/Zend/Filter/Callback.php

@@ -130,7 +130,7 @@ class Zend_Filter_Callback implements Zend_Filter_Interface
     /**
      * Calls the filter per callback
      *
-     * @param $value mixed Options for the set callback
+     * @param mixed $value Options for the set callback
      * @return mixed       Result from the filter which was callbacked
      */
     public function filter($value)
@@ -149,4 +149,4 @@ class Zend_Filter_Callback implements Zend_Filter_Interface
 
         return call_user_func_array($this->_callback, $options);
     }
-}
+}

library/Zend/Gdata/App.php

@@ -1087,7 +1087,7 @@ class Zend_Gdata_App
      * significant amount of time to complete. In some cases this may cause
      * execution to timeout without proper precautions in place.
      *
-     * @param $feed The feed to iterate through.
+     * @param object $feed The feed to iterate through.
      * @return mixed A new feed of the same type as the one originally
      *          passed in, containing all relevent entries.
      */
@@ -1117,7 +1117,7 @@ class Zend_Gdata_App
      * NOTE: This will not work if you have customized the adapter
      * already to use a proxy server or other interface.
      *
-     * @param $logfile The logfile to use when logging the requests
+     * @param string $logfile The logfile to use when logging the requests
      */
     public function enableRequestDebugLogging($logfile)
     {

library/Zend/Gdata/Media/Extension/MediaText.php

@@ -64,11 +64,11 @@ class Zend_Gdata_Media_Extension_MediaText extends Zend_Gdata_Extension
     /**
      * Constructs a new MediaText element
      *
-     * @param $text string
-     * @param $type string
-     * @param $lang string
-     * @param $start string
-     * @param $end string
+     * @param string $text
+     * @param string $type
+     * @param string $lang
+     * @param string $start
+     * @param string $end
      */
     public function __construct($text = null, $type = null, $lang = null,
             $start = null, $end = null)

library/Zend/Gdata/Spreadsheets/CellEntry.php

@@ -92,7 +92,8 @@ class Zend_Gdata_Spreadsheets_CellEntry extends Zend_Gdata_Entry
 
     /**
      * Sets the Cell element of this Cell Entry.
-     * @param $cell Zend_Gdata_Spreadsheets_Extension_Cell $cell
+     * @param Zend_Gdata_Spreadsheets_Extension_Cell $cell
+		 * @return Zend_Gdata_Spreadsheets_CellEntry
      */
     public function setCell($cell)
     {

library/Zend/Gdata/YouTube.php

@@ -844,11 +844,11 @@ class Zend_Gdata_YouTube extends Zend_Gdata_Media
     /**
      * Post a comment in reply to an existing comment
      *
-     * @param $commentEntry Zend_Gdata_YouTube_CommentEntry The comment entry
-     *        to reply to
-     * @param $commentText string The text of the comment to post
-     * @return A Zend_Gdata_YouTube_CommentEntry representing the posted
-     *         comment
+     * @param Zend_Gdata_YouTube_CommentEntry $commentEntry The comment entry
+     *         to reply to
+     * @param string                          $commentText  The text of the
+		 *         comment to post
+     * @return Zend_Gdata_YouTube_CommentEntry the posted comment
      */
     public function replyToCommentEntry($commentEntry, $commentText)
     {

library/Zend/Http/Response/Stream.php

@@ -90,7 +90,7 @@ class Zend_Http_Response_Stream extends Zend_Http_Response
     /**
      * Set the cleanup trigger
      *
-     * @param $cleanup Set cleanup trigger
+     * @param bool $cleanup Set cleanup trigger
      */
     public function setCleanup($cleanup = true) {
         $this->_cleanup = $cleanup;

library/Zend/Json/Encoder.php

@@ -85,7 +85,7 @@ class Zend_Json_Encoder
      *    - arrays (returns from {@link _encodeArray()})
      *    - basic datums (e.g. numbers or strings) (returns from {@link _encodeDatum()})
      *
-     * @param $value mixed The value to be encoded
+     * @param mixed $value The value to be encoded
      * @return string Encoded value
      */
     protected function _encodeValue(&$value)
@@ -108,7 +108,7 @@ class Zend_Json_Encoder
      * that contains the name of the class of $value. This is used to decode
      * the object on the client into a specific class.
      *
-     * @param $value object
+     * @param object $value
      * @return string
      * @throws Zend_Json_Exception If recursive checks are enabled and the object has been serialized previously
      */
@@ -182,7 +182,7 @@ class Zend_Json_Encoder
      * the last index is (count($array) -1); any deviation from that is
      * considered an associative array, and will be encoded as such.
      *
-     * @param $array array
+     * @param array& $array
      * @return string
      */
     protected function _encodeArray(&$array)
@@ -222,7 +222,7 @@ class Zend_Json_Encoder
      * If value type is not a string, number, boolean, or null, the string
      * 'null' is returned.
      *
-     * @param $value mixed
+     * @param mixed& $value
      * @return string
      */
     protected function _encodeDatum(&$value)
@@ -245,7 +245,7 @@ class Zend_Json_Encoder
     /**
      * JSON encode a string value by escaping characters as necessary
      *
-     * @param $value string
+     * @param string& $value
      * @return string
      */
     protected function _encodeString(&$string)
@@ -270,7 +270,7 @@ class Zend_Json_Encoder
      * Encode the constants associated with the ReflectionClass
      * parameter. The encoding format is based on the class2 format
      *
-     * @param $cls ReflectionClass
+     * @param ReflectionClass $cls
      * @return string Encoded constant block in class2 format
      */
     private static function _encodeConstants(ReflectionClass $cls)
@@ -295,7 +295,7 @@ class Zend_Json_Encoder
      * Encode the public methods of the ReflectionClass in the
      * class2 format
      *
-     * @param $cls ReflectionClass
+     * @param ReflectionClass $cls
      * @return string Encoded method fragment
      *
      */
@@ -359,7 +359,7 @@ class Zend_Json_Encoder
      * Encode the public properties of the ReflectionClass in the class2
      * format.
      *
-     * @param $cls ReflectionClass
+     * @param ReflectionClass $cls
      * @return string Encode properties list
      *
      */
@@ -391,10 +391,10 @@ class Zend_Json_Encoder
      * NOTE: Currently only public methods and variables are proxied onto
      * the client machine
      *
-     * @param $className string The name of the class, the class must be
-     * instantiable using a null constructor
-     * @param $package string Optional package name appended to JavaScript
-     * proxy class name
+     * @param string $className The name of the class, the class must be
+     *  instantiable using a null constructor
+     * @param string $package Optional package name appended to JavaScript
+     *  proxy class name
      * @return string The class2 (JavaScript) encoding of the class
      * @throws Zend_Json_Exception
      */

library/Zend/Log.php

@@ -503,8 +503,8 @@ class Zend_Log
     /**
      * Set an extra item to pass to the log writers.
      *
-     * @param  $name    Name of the field
-     * @param  $value   Value of the field
+     * @param  string $name    Name of the field
+     * @param  string $value   Value of the field
      * @return Zend_Log
      */
     public function setEventItem($name, $value)

library/Zend/Mail/Storage/Abstract.php

@@ -119,7 +119,7 @@ abstract class Zend_Mail_Storage_Abstract implements Countable, ArrayAccess, See
     /**
      * Get a message with headers and body
      *
-     * @param  $id int number of message
+     * @param int $id number of message
      * @return Zend_Mail_Message
      */
     abstract public function getMessage($id);

library/Zend/Mail/Storage/Folder/Maildir.php

@@ -77,7 +77,7 @@ class Zend_Mail_Storage_Folder_Maildir extends Zend_Mail_Storage_Maildir impleme
      *   - delim   delim char for folder structur, default is '.'
      *   - folder intial selected folder, default is 'INBOX'
      *
-     * @param  $params array mail reader specific parameters
+     * @param array $params mail reader specific parameters
      * @throws Zend_Mail_Storage_Exception
      */
     public function __construct($params)

library/Zend/Mail/Storage/Folder/Mbox.php

@@ -73,7 +73,7 @@ class Zend_Mail_Storage_Folder_Mbox extends Zend_Mail_Storage_Mbox implements Ze
      *   - dirname rootdir of mbox structure
      *   - folder intial selected folder, default is 'INBOX'
      *
-     * @param  $params array mail reader specific parameters
+     * @param array $params mail reader specific parameters
      * @throws Zend_Mail_Storage_Exception
      */
     public function __construct($params)

library/Zend/Mail/Storage/Maildir.php

@@ -257,7 +257,7 @@ class Zend_Mail_Storage_Maildir extends Zend_Mail_Storage_Abstract
      * Supported parameters are:
      *   - dirname dirname of mbox file
      *
-     * @param  $params array mail reader specific parameters
+     * @param array $params mail reader specific parameters
      * @throws Zend_Mail_Storage_Exception
      */
     public function __construct($params)

library/Zend/Mail/Storage/Mbox.php

@@ -216,7 +216,7 @@ class Zend_Mail_Storage_Mbox extends Zend_Mail_Storage_Abstract
      * Supported parameters are:
      *   - filename filename of mbox file
      *
-     * @param  $params array mail reader specific parameters
+     * @param array $params mail reader specific parameters
      * @throws Zend_Mail_Storage_Exception
      */
     public function __construct($params)

library/Zend/Mail/Storage/Pop3.php

@@ -154,7 +154,7 @@ class Zend_Mail_Storage_Pop3 extends Zend_Mail_Storage_Abstract
      *   - port port for POP3 server [optional, default = 110]
      *   - ssl 'SSL' or 'TLS' for secure sockets
      *
-     * @param  $params array  mail reader specific parameters
+     * @param array $params mail reader specific parameters
      * @throws Zend_Mail_Storage_Exception
      * @throws Zend_Mail_Protocol_Exception
      */

library/Zend/Mail/Storage/Writable/Maildir.php

@@ -105,7 +105,7 @@ class Zend_Mail_Storage_Writable_Maildir extends    Zend_Mail_Storage_Folder_Mai
      * Additional parameters are (see parent for more):
      *   - create if true a new maildir is create if none exists
      *
-     * @param  $params array mail reader specific parameters
+     * @param array $params mail reader specific parameters
      * @throws Zend_Mail_Storage_Exception
      */
     public function __construct($params) {

library/Zend/Measure/Abstract.php

@@ -74,9 +74,9 @@ abstract class Zend_Measure_Abstract
     /**
      * Zend_Measure_Abstract is an abstract class for the different measurement types
      *
-     * @param  $value  mixed  - Value as string, integer, real or float
-     * @param  $type   type   - OPTIONAL a measure type f.e. Zend_Measure_Length::METER
-     * @param  $locale locale - OPTIONAL a Zend_Locale Type
+     * @param  mixed       $value  Value as string, integer, real or float
+     * @param  int         $type   OPTIONAL a measure type f.e. Zend_Measure_Length::METER
+     * @param  Zend_Locale $locale OPTIONAL a Zend_Locale Type
      * @throws Zend_Measure_Exception
      */
     public function __construct($value, $type = null, $locale = null)

library/Zend/Pdf/Annotation.php

@@ -220,7 +220,7 @@ abstract class Zend_Pdf_Annotation
      * Load Annotation object from a specified resource
      *
      * @internal
-     * @param $destinationArray
+     * @param Zend_Pdf_Element $resource
      * @return Zend_Pdf_Annotation
      */
     public static function load(Zend_Pdf_Element $resource)

library/Zend/Pdf/Destination.php

@@ -43,7 +43,7 @@ abstract class Zend_Pdf_Destination extends Zend_Pdf_Target
      * Load Destination object from a specified resource
      *
      * @internal
-     * @param $destinationArray
+     * @param Zend_Pdf_Element $resource
      * @return Zend_Pdf_Destination
      */
     public static function load(Zend_Pdf_Element $resource)

library/Zend/Pdf/Destination/Named.php

@@ -54,7 +54,7 @@ class Zend_Pdf_Destination_Named extends Zend_Pdf_Destination
     /**
      * Named destination object constructor
      *
-     * @param $resource
+     * @param Zend_Pdf_Element $resource
      * @throws Zend_Pdf_Exception
      */
     public function __construct(Zend_Pdf_Element $resource)

library/Zend/Pdf/NameTree.php

@@ -46,7 +46,7 @@ class Zend_Pdf_NameTree implements ArrayAccess, Iterator, Countable
     /**
      * Object constructor
      *
-     * @param $rootDictionary root of name dictionary
+     * @param Zend_Pdf_Element $rootDictionary root of name dictionary
      */
     public function __construct(Zend_Pdf_Element $rootDictionary)
     {

library/Zend/Queue/Adapter/Array.php

@@ -344,7 +344,7 @@ class Zend_Queue_Adapter_Array extends Zend_Queue_Adapter_AdapterAbstract
      * sets the underlying _data array
      * $queue->getAdapter()->setData($data);
      *
-     * @param $data array
+     * @param array $data
      * @return $this;
      */
     public function setData($data)

library/Zend/Search/Lucene/Document.php

@@ -57,7 +57,7 @@ class Zend_Search_Lucene_Document
      * Proxy method for getFieldValue(), provides more convenient access to
      * the string value of a field.
      *
-     * @param  $offset
+     * @param  string $offset
      * @return string
      */
     public function __get($offset)

library/Zend/Search/Lucene/Search/Weight.php

@@ -78,7 +78,7 @@ abstract class Zend_Search_Lucene_Search_Weight
     /**
      * Assigns the query normalization factor to this.
      *
-     * @param $norm
+     * @param float $norm
      */
     abstract public function normalize($norm);
 }

library/Zend/Service/Amazon/Authentication/V2.php

@@ -77,7 +77,7 @@ class Zend_Service_Amazon_Authentication_V2 extends Zend_Service_Amazon_Authenti
 
     /**
      * Set http request type to POST or GET
-     * @param $method string
+     * @param string $method
      */
     public function setHttpMethod($method = "POST") {
         $this->_httpMethod = strtoupper($method);

library/Zend/Service/Amazon/SimpleDb.php

@@ -283,8 +283,8 @@ class Zend_Service_Amazon_SimpleDb extends Zend_Service_Amazon_Abstract
     /**
      * List domains
      *
-     * @param $maxNumberOfDomains int
-     * @param $nextToken          int
+     * @param int $maxNumberOfDomains
+     * @param int $nextToken
      * @return array              0 or more domain names
      */
     public function listDomains($maxNumberOfDomains = 100, $nextToken = null)
@@ -315,7 +315,7 @@ class Zend_Service_Amazon_SimpleDb extends Zend_Service_Amazon_Abstract
     /**
      * Retrieve domain metadata
      *
-     * @param $domainName string Name of the domain for which metadata will be requested
+     * @param string $domainName Name of the domain for which metadata will be requested
      * @return array Key/value array of metadatum names and values.
      */
     public function domainMetadata($domainName)
@@ -340,8 +340,8 @@ class Zend_Service_Amazon_SimpleDb extends Zend_Service_Amazon_Abstract
     /**
      * Create a new domain
      *
-     * @param $domainName    string    Valid domain name of the domain to create
-     * @return                 boolean True if successful, false if not
+     * @param string $domainName Valid domain name of the domain to create
+     * @return boolean True if successful, false if not
      */
     public function createDomain($domainName)
     {
@@ -355,8 +355,8 @@ class Zend_Service_Amazon_SimpleDb extends Zend_Service_Amazon_Abstract
     /**
      * Delete a domain
      *
-     * @param     $domainName string  Valid domain name of the domain to delete
-     * @return                 boolean True if successful, false if not
+     * @param string $domainName Valid domain name of the domain to delete
+     * @return boolean True if successful, false if not
      */
     public function deleteDomain($domainName)
     {

library/Zend/Service/DeveloperGarden/ConferenceCall/ConferenceDetail.php

@@ -90,7 +90,7 @@ class Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail
     /**
      * set the description of this conference
      *
-     * @param $description the $description to set
+     * @param string $description the $description to set
      * @return Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail
      */
     public function setDescription($description)

library/Zend/Service/DeveloperGarden/Credential.php

@@ -134,7 +134,7 @@ class Zend_Service_DeveloperGarden_Credential
      * if $withRealm == true we combine username and realm like
      * username@realm
      *
-     * @param $boolean withRealm
+     * @param bool $withRealm
      * @return string|null
      */
     public function getUsername($withRealm = false)

library/Zend/Service/DeveloperGarden/LocalSearch/SearchParameters.php

@@ -294,10 +294,10 @@ class Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
      * rx = longitude right bottom
      * ry = latitude right bottom
      *
-     * @param $lx
-     * @param $ly
-     * @param $rx
-     * @param $ry
+     * @param float $lx
+     * @param float $ly
+     * @param float $rx
+     * @param float $ry
      * @return Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
      */
     public function setRectangle($lx, $ly, $rx, $ry)
@@ -416,8 +416,8 @@ class Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
      * sets a category filter
      *
      * @see http://www.suchen.de/kategorie-katalog
-     * @param $category
-     * @return unknown_type
+     * @param string $category
+     * @return Zend_Service_DeveloperGarden_LocalSearch_SearchParameters
      */
     public function setCategory($category = null)
     {

library/Zend/Service/DeveloperGarden/Request/ConferenceCall/CreateConferenceRequest.php

@@ -125,7 +125,7 @@ class Zend_Service_DeveloperGarden_Request_ConferenceCall_CreateConferenceReques
     /**
      * sets $account
      *
-     * @param $account
+     * @param int $account
      * @return Zend_Service_DeveloperGarden_Request_ConferenceCall_CreateConferenceRequest
      */
     public function setAccount($account = null)

library/Zend/Service/DeveloperGarden/Request/ConferenceCall/GetConferenceListRequest.php

@@ -93,7 +93,7 @@ class Zend_Service_DeveloperGarden_Request_ConferenceCall_GetConferenceListReque
     /**
      * sets $ownerId
      *
-     * @param $ownerId
+     * @param int $ownerId
      * @return Zend_Service_DeveloperGarden_Request_ConferenceCall_GetConferenceListRequest
      */
     public function setOwnerId($ownerId)

library/Zend/Service/DeveloperGarden/Request/ConferenceCall/GetConferenceTemplateListRequest.php

@@ -58,7 +58,7 @@ class Zend_Service_DeveloperGarden_Request_ConferenceCall_GetConferenceTemplateL
     /**
      * sets $ownerId
      *
-     * @param $ownerId
+     * @param int $ownerId
      * @return Zend_Service_DeveloperGarden_Request_ConferenceCall_GetConferenceTemplateListRequest
      */
     public function setOwnerId($ownerId)

library/Zend/Service/DeveloperGarden/Request/ConferenceCall/UpdateConferenceRequest.php

@@ -147,7 +147,7 @@ class Zend_Service_DeveloperGarden_Request_ConferenceCall_UpdateConferenceReques
     /**
      * sets $account
      *
-     * @param $account
+     * @param int $account
      * @return Zend_Service_DeveloperGarden_Request_ConferenceCall_CreateConferenceRequest
      */
     public function setAccount($account = null)

library/Zend/Service/DeveloperGarden/Request/SendSms/SendSmsAbstract.php

@@ -207,7 +207,7 @@ abstract class Zend_Service_DeveloperGarden_Request_SendSms_SendSmsAbstract
     /**
      * sets a new accounts
      *
-     * @param $account the $account to set
+     * @param int $account the $account to set
      * @return Zend_Service_DeveloperGarden_Request_SendSms_SendSmsAbstract
      */
     public function setAccount($account)

library/Zend/Service/LiveDocx.php

@@ -147,7 +147,7 @@ class Zend_Service_LiveDocx
      * Set options
      * One or more of username, password, soapClient
      *
-     * @param  $options
+     * @param  array $options
      * @return Zend_Service_LiveDocx
      * @since  LiveDocx 1.2
      */
@@ -412,4 +412,4 @@ class Zend_Service_LiveDocx
     {
         return version_compare($version, $this->getVersion());
     }
-}
+}

library/Zend/Service/Nirvanix/Namespace/Base.php

@@ -76,7 +76,7 @@ class Zend_Service_Nirvanix_Namespace_Base
     /**
      * Class constructor.
      *
-     * @param  $options  array  Options and dependency injection
+     * @param array $options Options and dependency injection
      */
     public function __construct($options = array())
     {

library/Zend/Service/StrikeIron/Base.php

@@ -193,10 +193,10 @@ class Zend_Service_StrikeIron_Base
      * on what was originally called.
      *
      * @see    __call()
-     * @param  $result  Raw result returned from SOAPClient_>__soapCall()
-     * @param  $method  Method name that was passed to SOAPClient->__soapCall()
-     * @param  $params  Method parameters that were passed to SOAPClient->__soapCall()
-     * @return mixed    Transformed result
+     * @param  object $result  Raw result returned from SOAPClient_>__soapCall()
+     * @param  string $method  Method name that was passed to SOAPClient->__soapCall()
+     * @param  array  $params  Method parameters that were passed to SOAPClient->__soapCall()
+     * @return mixed  Transformed result
      */
     protected function _transformResult($result, $method, $params)
     {

library/Zend/Service/Twitter.php

@@ -923,8 +923,7 @@ class Zend_Service_Twitter extends Zend_Rest_Client
 
     /**
      * Protected function to validate that the integer is valid or return a 0
-     * @param $int
-     * @throws Zend_Http_Client_Exception if HTTP request fails or times out
+     * @param mixed $int
      * @return integer
      */
     protected function _validInteger($int)

library/Zend/Session.php

@@ -335,7 +335,7 @@ class Zend_Session extends Zend_Session_Abstract
      * seconds is specified, then this defaults to self::$_rememberMeSeconds.  Due to clock errors on end users' systems,
      * large values are recommended to avoid undesirable expiration of session cookies.
      *
-     * @param $seconds integer - OPTIONAL specifies TTL for cookie in seconds from present time
+     * @param int $seconds OPTIONAL specifies TTL for cookie in seconds from present time
      * @return void
      */
     public static function rememberMe($seconds = null)

library/Zend/Soap/AutoDiscover.php

@@ -378,10 +378,10 @@ class Zend_Soap_AutoDiscover implements Zend_Server_Interface
     /**
      * Add a function to the WSDL document.
      *
-     * @param $function Zend_Server_Reflection_Function_Abstract function to add
-     * @param $wsdl Zend_Soap_Wsdl WSDL document
-     * @param $port object wsdl:portType
-     * @param $binding object wsdl:binding
+     * @param Zend_Server_Reflection_Function_Abstract $function function to add
+     * @param Zend_Soap_Wsdl                           $wsdl     WSDL document
+     * @param object                                   $port     wsdl:portType
+     * @param object                                   $binding  wsdl:binding
      * @return void
      */
     protected function _addFunctionToWsdl($function, $wsdl, $port, $binding)

library/Zend/TimeSync.php

@@ -233,7 +233,7 @@ class Zend_TimeSync implements IteratorAggregate
      * facade and will try to return the date from the first server that
      * returns a valid result.
      *
-     * @param   $locale - OPTIONAL locale
+     * @param   Zend_Locale $locale - OPTIONAL locale
      * @return  object
      * @throws  Zend_TimeSync_Exception
      */

library/Zend/Tool/Framework/Client/Console.php

@@ -42,6 +42,8 @@ require_once 'Zend/Tool/Framework/Client/Interactive/OutputInterface.php';
  * @package    Zend_Tool
  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ *
+ * @todo methods need more API documentation.
  */
 class Zend_Tool_Framework_Client_Console
     extends Zend_Tool_Framework_Client_Abstract
@@ -98,7 +100,7 @@ class Zend_Tool_Framework_Client_Console
     /**
      * setConfigOptions()
      *
-     * @param $configOptions
+     * @param array $configOptions
      */
     public function setConfigOptions($configOptions)
     {
@@ -109,7 +111,7 @@ class Zend_Tool_Framework_Client_Console
     /**
      * setStorageOptions()
      *
-     * @param $storageOptions
+     * @param array $storageOptions
      */
     public function setStorageOptions($storageOptions)
     {
@@ -117,6 +119,9 @@ class Zend_Tool_Framework_Client_Console
         return $this;
     }
 
+    /**
+		 * @param array $classesToLoad
+		 */
     public function setClassesToLoad($classesToLoad)
     {
         $this->_classesToLoad = $classesToLoad;

library/Zend/Tool/Framework/Metadata/Dynamic.php

@@ -78,7 +78,7 @@ class Zend_Tool_Framework_Metadata_Dynamic
     /**
      * setType()
      *
-     * @param $type
+     * @param string $type
      * @return Zend_Tool_Framework_Metadata_Dynamic
      */
     public function setType($type)
@@ -102,7 +102,7 @@ class Zend_Tool_Framework_Metadata_Dynamic
     /**
      * setName()
      *
-     * @param $name
+     * @param string $name
      * @return Zend_Tool_Framework_Metadata_Dynamic
      */
     public function setName($name)
@@ -126,7 +126,7 @@ class Zend_Tool_Framework_Metadata_Dynamic
     /**
      * setValue()
      *
-     * @param $value
+     * @param mixed $value
      * @return Zend_Tool_Framework_Metadata_Dynamic
      */
     public function setValue($value)

library/Zend/Tool/Project/Context/Zf/AbstractClassFile.php

@@ -37,8 +37,8 @@ abstract class Zend_Tool_Project_Context_Zf_AbstractClassFile extends Zend_Tool_
     /**
      * getFullClassName()
      *
-     * @param $localClassName
-     * @param $classContextName
+     * @param string $localClassName
+     * @param string $classContextName
      */
     public function getFullClassName($localClassName, $classContextName = null)
     {

library/Zend/Tool/Project/Provider/Abstract.php

@@ -118,9 +118,9 @@ abstract class Zend_Tool_Project_Provider_Abstract
      *    - if an enpoint variable has been registered in teh client registry - key=workingDirectory
      *    - if an ENV variable with the key ZFPROJECT_PATH is found
      *
-     * @param $loadProfileFlag bool Whether or not to throw an exception when no profile is found
-     * @param $projectDirectory string The project directory to use to search
-     * @param $searchParentDirectories bool Whether or not to search upper level direcotries
+     * @param bool   $loadProfileFlag         Whether or not to throw an exception when no profile is found
+     * @param string $projectDirectory        The project directory to use to search
+     * @param bool   $searchParentDirectories Whether or not to search upper level direcotries
      * @return Zend_Tool_Project_Profile
      */
     protected function _loadProfile($loadProfileFlag = self::NO_PROFILE_THROW_EXCEPTION, $projectDirectory = null, $searchParentDirectories = true)

library/Zend/Tool/Project/Provider/Application.php

@@ -35,8 +35,8 @@ class Zend_Tool_Project_Provider_Application
 
     /**
      *
-     * @param $classNamePrefix Prefix of classes
-     * @param $force
+     * @param string $classNamePrefix Prefix of classes
+     * @param bool   $force
      */
     public function changeClassNamePrefix($classNamePrefix /* , $force = false */)
     {

library/Zend/View/Abstract.php

@@ -948,7 +948,7 @@ abstract class Zend_View_Abstract implements Zend_View_Interface
     /**
      * Finds a view script from the available directories.
      *
-     * @param $name string The base name of the script.
+     * @param string $name The base name of the script.
      * @return void
      */
     protected function _script($name)

library/Zend/View/Helper/Cycle.php

@@ -92,7 +92,7 @@ class Zend_View_Helper_Cycle implements Iterator
     /**
      * Sets actual name of cycle
      *
-     * @param $name
+     * @param string $name
      * @return Zend_View_Helper_Cycle
      */
     public function setName($name = self::DEFAULT_NAME)
@@ -111,7 +111,6 @@ class Zend_View_Helper_Cycle implements Iterator
     /**
      * Gets actual name of cycle
      *
-     * @param $name
      * @return string
      */
     public function getName()

library/Zend/View/Helper/FormElement.php

@@ -54,7 +54,7 @@ abstract class Zend_View_Helper_FormElement extends Zend_View_Helper_HtmlElement
     /**
      * Set translator
      *
-     * @param  $translator|null Zend_Translate
+     * @param  Zend_Translate $translator
      * @return Zend_View_Helper_FormElement
      */
     public function setTranslator($translator = null)
@@ -178,11 +178,9 @@ abstract class Zend_View_Helper_FormElement extends Zend_View_Helper_HtmlElement
      *
      * @access protected
      *
-     * @param $name The element name.
-     *
-     * @param $value The element value.
-     *
-     * @param $attribs Attributes for the element.
+     * @param string $name The element name.
+     * @param string $value The element value.
+     * @param array  $attribs Attributes for the element.
      *
      * @return string A hidden element.
      */

library/Zend/View/Helper/RenderToPlaceholder.php

@@ -40,8 +40,8 @@ class Zend_View_Helper_RenderToPlaceholder extends Zend_View_Helper_Abstract
      * Renders a template and stores the rendered output as a placeholder
      * variable for later use.
      *
-     * @param $script The template script to render
-     * @param $placeholder The placeholder variable name in which to store the rendered output
+     * @param string $script The template script to render
+     * @param string $placeholder The placeholder variable name in which to store the rendered output
      * @return void
      */
     public function renderToPlaceholder($script, $placeholder)

library/Zend/Wildfire/Channel/HttpHeaders.php

@@ -115,7 +115,7 @@ class Zend_Wildfire_Channel_HttpHeaders extends Zend_Controller_Plugin_Abstract
     /**
      * Get or create singleton instance
      *
-     * @param $skipCreate boolean True if an instance should not be created
+     * @param bool $skipCreate True if an instance should not be created
      * @return Zend_Wildfire_Channel_HttpHeaders
      */
     public static function getInstance($skipCreate=false)

library/Zend/Wildfire/Plugin/FirePhp.php

@@ -214,7 +214,7 @@ class Zend_Wildfire_Plugin_FirePhp implements Zend_Wildfire_Plugin_Interface
     /**
      * Get or create singleton instance
      *
-     * @param $skipCreate boolean True if an instance should not be created
+     * @param bool $skipCreate True if an instance should not be created
      * @return Zend_Wildfire_Plugin_FirePhp
      */
     public static function getInstance($skipCreate=false)

library/Zend/XmlRpc/Client.php

@@ -211,7 +211,7 @@ class Zend_XmlRpc_Client
     /**
      * Returns a proxy object for more convenient method calls
      *
-     * @param $namespace  Namespace to proxy or empty string for none
+     * @param string $namespace  Namespace to proxy or empty string for none
      * @return Zend_XmlRpc_Client_ServerProxy
      */
     public function getProxy($namespace = '')

library/Zend/XmlRpc/Value.php

@@ -507,7 +507,7 @@ abstract class Zend_XmlRpc_Value
     }
 
     /**
-     * @param $xml
+     * @param string $xml
      * @return void
      */
     protected function _setXML($xml)

tests/Zend/Service/Amazon/SimpleDb/OnlineTest.php

@@ -343,12 +343,6 @@ class Zend_Service_Amazon_SimpleDb_OnlineTest extends PHPUnit_Framework_TestCase
         }
     }
 
-    /**
-     *
-     * @param $maxNumberOfDomains Integer between 1 and 100
-     * @param $nextToken          Integer between 1 and 100
-     * @return array              0 or more domain names
-     */
     public function testListDomains() {
         $domainName = null;
         try {
@@ -394,10 +388,6 @@ class Zend_Service_Amazon_SimpleDb_OnlineTest extends PHPUnit_Framework_TestCase
         }
     }
 
-    /**
-     * @param $domainName string Name of the domain for which metadata will be requested
-     * @return array Key/value array of metadatum names and values.
-     */
     public function testDomainMetadata() {
         $domainName = $this->_testDomainNamePrefix . '_testDomainMetadata';
         $this->_amazon->deleteDomain($domainName);
@@ -428,11 +418,6 @@ class Zend_Service_Amazon_SimpleDb_OnlineTest extends PHPUnit_Framework_TestCase
         }
     }
 
-    /**
-     *
-     * @param $domainName	string	Valid domain name of the domain to create
-     * @return 				boolean True if successful, false if not
-     */
 	public function testCreateDomain() {
 	    $domainName = $this->_testDomainNamePrefix . '_testCreateDomain';
         $this->_amazon->deleteDomain($domainName);