Fix ApiGen errors

This commit is contained in:
Eric Martins 2014-02-07 12:45:00 -02:00
parent 96048f401a
commit 2793dca671
18 changed files with 194 additions and 17 deletions

View file

@ -73,6 +73,8 @@ class NumberHelper extends AppHelper {
}
/**
* Formats a number with a level of precision.
*
* @see CakeNumber::precision()
*
* @param float $number A floating point number.
@ -85,6 +87,8 @@ class NumberHelper extends AppHelper {
}
/**
* Returns a formatted-for-humans file size.
*
* @see CakeNumber::toReadableSize()
*
* @param integer $size Size in bytes
@ -96,6 +100,8 @@ class NumberHelper extends AppHelper {
}
/**
* - `multiply`: Multiply the input value by 100 for decimal percentages.
*
* @see CakeNumber::toPercentage()
*
* @param float $number A floating point number
@ -109,6 +115,8 @@ class NumberHelper extends AppHelper {
}
/**
* Formats a number into a currency format.
*
* @see CakeNumber::format()
*
* @param float $number A floating point number
@ -122,6 +130,8 @@ class NumberHelper extends AppHelper {
}
/**
* Formats a number into a currency format.
*
* @see CakeNumber::currency()
*
* @param float $number
@ -137,6 +147,18 @@ class NumberHelper extends AppHelper {
}
/**
* Add a currency format to the Number helper. Makes reusing
* currency formats easier.
*
* {{{ $this->Number->addFormat('NOK', array('before' => 'Kr. ')); }}}
*
* You can now use `NOK` as a shortform when formatting currency amounts.
*
* {{{ $this->Number->currency($value, 'NOK'); }}}
*
* Added formats are merged with the defaults defined in Cake\Utility\Number::$_currencyDefaults
* See Cake\Utility\Number::currency() for more information on the various options and their function.
*
* @see CakeNumber::addFormat()
*
* @param string $formatName The format name to be used in the future.
@ -150,6 +172,8 @@ class NumberHelper extends AppHelper {
}
/**
* Getter/setter for default currency
*
* @see CakeNumber::defaultCurrency()
*
* @param string $currency The currency to be used in the future.