Browse Source

More docblock CS fixes.

ADmad 12 years ago
parent
commit
7a4244d0a6

+ 7 - 7
lib/Cake/Utility/CakeNumber.php

@@ -243,7 +243,7 @@ class CakeNumber {
  * - `decimals` - Decimal separator symbol ie. '.'
  *
  * @param float $value A floating point number
- * @param array $options
+ * @param array $options Options list.
  * @return string formatted delta
  * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::formatDelta
  */
@@ -258,10 +258,10 @@ class CakeNumber {
 /**
  * Alternative number_format() to accommodate multibyte decimals and thousands < PHP 5.4
  *
- * @param float $value
- * @param integer $places
- * @param string $decimals
- * @param string $thousands
+ * @param float $value Value to format.
+ * @param integer $places Decimal places to use.
+ * @param string $decimals Decimal position string.
+ * @param string $thousands Thousands separator string.
  * @return string
  */
 	protected static function _numberFormat($value, $places = 0, $decimals = '.', $thousands = ',') {
@@ -315,10 +315,10 @@ class CakeNumber {
  *   By default all currencies contain utf-8 symbols and don't need this changed. If you require
  *   non HTML encoded symbols you will need to update the settings with the correct bytes.
  *
- * @param float $value
+ * @param float $value Value to format.
  * @param string $currency Shortcut to default options. Valid values are
  *   'USD', 'EUR', 'GBP', otherwise set at least 'before' and 'after' options.
- * @param array $options
+ * @param array $options Options list.
  * @return string Number formatted as a currency.
  * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::currency
  */

+ 3 - 2
lib/Cake/Utility/ClassRegistry.php

@@ -86,6 +86,7 @@ class ClassRegistry {
  *		array('class' => 'ClassName', 'alias' => 'AliasNameStoredInTheRegistry')
  * );
  * }}}
+ *
  * @param string|array $class as a string or a single key => value array instance will be created,
  *  stored in the registry and returned.
  * @param boolean $strict if set to true it will return false if the class was not found instead
@@ -303,8 +304,8 @@ class ClassRegistry {
 /**
  * Checks to see if $alias is a duplicate $class Object
  *
- * @param string $alias
- * @param string $class
+ * @param string $alias Alias to check.
+ * @param string $class Class name.
  * @return boolean
  */
 	protected function &_duplicate($alias, $class) {

+ 2 - 3
lib/Cake/Utility/Debugger.php

@@ -148,7 +148,7 @@ class Debugger {
 /**
  * Returns a reference to the Debugger singleton object instance.
  *
- * @param string $class
+ * @param string $class Debugger class name.
  * @return object
  */
 	public static function getInstance($class = null) {
@@ -167,7 +167,6 @@ class Debugger {
 /**
  * Recursively formats and outputs the contents of the supplied variable.
  *
- *
  * @param mixed $var the variable to dump
  * @param int $depth The depth to output to. Defaults to 3.
  * @return void
@@ -724,7 +723,7 @@ class Debugger {
 /**
  * Takes a processed array of data from an error and displays it in the chosen format.
  *
- * @param string $data
+ * @param string $data Data to output.
  * @return void
  */
 	public function outputError($data) {

+ 1 - 1
lib/Cake/Utility/File.php

@@ -202,7 +202,7 @@ class File {
  * all other platforms will use "\n"
  *
  * @param string $data Data to prepare for writing.
- * @param boolean $forceWindows
+ * @param boolean $forceWindows If true forces usage Windows newline string.
  * @return string The with converted line endings.
  * @link http://book.cakephp.org/2.0/en/core-utility-libraries/file-folder.html#File::prepare
  */

+ 2 - 2
lib/Cake/Utility/Hash.php

@@ -671,7 +671,7 @@ class Hash {
 /**
  * Checks to see if all the values in the array are numeric
  *
- * @param array $array The array to check.
+ * @param array $data The array to check.
  * @return boolean true if values are numeric, false otherwise
  * @link http://book.cakephp.org/2.0/en/core-utility-libraries/hash.html#Hash::numeric
  */
@@ -689,7 +689,7 @@ class Hash {
  * If you have an un-even or heterogenous array, consider using Hash::maxDimensions()
  * to get the dimensions of the array.
  *
- * @param array $array Array to count dimensions on
+ * @param array $data Array to count dimensions on
  * @return integer The number of dimensions in $data
  * @link http://book.cakephp.org/2.0/en/core-utility-libraries/hash.html#Hash::dimensions
  */

+ 1 - 1
lib/Cake/Utility/Inflector.php

@@ -521,7 +521,7 @@ class Inflector {
 /**
  * Returns camelBacked version of an underscored string.
  *
- * @param string $string
+ * @param string $string String to convert.
  * @return string in variable form
  * @link http://book.cakephp.org/2.0/en/core-utility-libraries/inflector.html#Inflector::variable
  */

+ 3 - 4
lib/Cake/Utility/ObjectCollection.php

@@ -82,8 +82,7 @@ abstract class ObjectCollection {
  *    Any non-null value will modify the parameter index indicated.
  *    Defaults to false.
  *
- *
- * @param string $callback|CakeEvent Method to fire on all the objects. Its assumed all the objects implement
+ * @param string|CakeEvent $callback Method to fire on all the objects. Its assumed all the objects implement
  *   the method you are calling. If an instance of CakeEvent is provided, then then Event name will parsed to
  *   get the callback name. This is done by getting the last word after any dot in the event name
  *   (eg. `Model.afterSave` event will trigger the `afterSave` callback)
@@ -172,7 +171,7 @@ abstract class ObjectCollection {
  * Enables callbacks on an object or array of objects
  *
  * @param string|array $name CamelCased name of the object(s) to enable (string or array)
- * @param boolean Prioritize enabled list after enabling object(s)
+ * @param boolean $prioritize Prioritize enabled list after enabling object(s)
  * @return void
  */
 	public function enable($name, $prioritize = true) {
@@ -213,7 +212,7 @@ abstract class ObjectCollection {
  * @param string|array $name CamelCased name of the object(s) to enable (string or array)
  * 	If string the second param $priority is used else it should be an associative array
  * 	with keys as object names and values as priorities to set.
- * @param integer|null Integer priority to set or null for default
+ * @param integer|null $priority Integer priority to set or null for default
  * @return void
  */
 	public function setPriority($name, $priority = null) {

+ 1 - 1
lib/Cake/Utility/Security.php

@@ -324,7 +324,7 @@ class Security {
 /**
  * Check the encryption key for proper length.
  *
- * @param string $key
+ * @param string $key Key to check.
  * @param string $method The method the key is being checked for.
  * @return void
  * @throws CakeException When key length is not 256 bit/32 bytes

+ 9 - 9
lib/Cake/Utility/Validation.php

@@ -398,8 +398,8 @@ class Validation {
  * - true => Any number of decimal places greater than 0, or a float|double. The '.' is required.
  * - 1..N => Exactly that many number of decimal places. The '.' is required.
  *
- * @param float $check The value the test for decimal
- * @param integer $places
+ * @param float $check The value the test for decimal.
+ * @param integer $places Decimal places.
  * @param string $regex If a custom regular expression is used, this is the only validation that will occur.
  * @return boolean Success
  */
@@ -900,8 +900,8 @@ class Validation {
 /**
  * Luhn algorithm
  *
- * @param string|array $check
- * @param boolean $deep
+ * @param string|array $check Value to check.
+ * @param boolean $deep If true performs deep check.
  * @return boolean Success
  * @see http://en.wikipedia.org/wiki/Luhn_algorithm
  */
@@ -933,7 +933,7 @@ class Validation {
 /**
  * Checks the mime type of a file.
  *
- * @param string|array $check
+ * @param string|array $check Value to check.
  * @param array|string $mimeTypes Array of mime types or regex pattern to check.
  * @return boolean Success
  * @throws CakeException when mime type can not be determined.
@@ -963,9 +963,9 @@ class Validation {
 /**
  * Checks the filesize
  *
- * @param string|array $check
- * @param integer|string $size Size in bytes or human readable string like '5MB'
- * @param string $operator See `Validation::comparison()`
+ * @param string|array $check Value to check.
+ * @param string $operator See `Validation::comparison()`.
+ * @param integer|string $size Size in bytes or human readable string like '5MB'.
  * @return boolean Success
  */
 	public static function fileSize($check, $operator = null, $size = null) {
@@ -984,7 +984,7 @@ class Validation {
 /**
  * Checking for upload errors
  *
- * @param string|array $check
+ * @param string|array $check Value to check.
  * @return boolean
  * @see http://www.php.net/manual/en/features.file-upload.errors.php
  */

+ 2 - 2
lib/Cake/Utility/Xml.php

@@ -228,7 +228,7 @@ class Xml {
  *
  * @param DOMDocument $dom Handler to DOMDocument
  * @param DOMElement $node Handler to DOMElement (child)
- * @param array $data Array of data to append to the $node.
+ * @param array &$data Array of data to append to the $node.
  * @param string $format Either 'attribute' or 'tags'. This determines where nested keys go.
  * @return void
  * @throws XmlException
@@ -348,7 +348,7 @@ class Xml {
  * Recursive method to toArray
  *
  * @param SimpleXMLElement $xml SimpleXMLElement object
- * @param array $parentData Parent array with data
+ * @param array &$parentData Parent array with data
  * @param string $ns Namespace of current child
  * @param array $namespaces List of namespaces in XML
  * @return void