Document exceptions thrown by \OC\LargeFileHelper.

This commit is contained in:
Andreas Fischer 2014-03-16 20:05:06 +01:00
parent ea246d058e
commit 2929d19c7f
1 changed files with 7 additions and 2 deletions

View File

@ -25,8 +25,10 @@ class LargeFileHelper {
const POW_2_53_MINUS_1 = '9007199254740991';
/**
* @brief Constructor. Checks whether our assumptions hold on the platform
* we are on, throws an exception if they do not hold.
* @brief Checks whether our assumptions hold on the PHP platform we are on.
*
* @throws \RunTimeException if our assumptions do not hold on the current
* PHP platform.
*/
public function __construct() {
$pow_2_53 = floatval(self::POW_2_53_MINUS_1) + 1.0;
@ -43,6 +45,9 @@ class LargeFileHelper {
*
* @param int|float|string $number Number containing unsigned integer data
*
* @throws \UnexpectedValueException if $number is not a float, not an int
* and not a base-10 string.
*
* @return string Unsigned integer base-10 string
*/
public function formatUnsignedInteger($number) {