summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorAndreas Fischer <bantu@owncloud.com>2014-03-16 20:05:06 +0100
committerAndreas Fischer <bantu@owncloud.com>2014-05-29 16:26:02 +0200
commit2929d19c7f0b87d8207cbeff35607b8c27674ebf (patch)
treeb0178bb7c65ea028faf563befd07b8b6e862bee3 /lib
parentea246d058ed86acc6634d34888d61f2a953e6ce1 (diff)
downloadnextcloud-server-2929d19c7f0b87d8207cbeff35607b8c27674ebf.tar.gz
nextcloud-server-2929d19c7f0b87d8207cbeff35607b8c27674ebf.zip
Document exceptions thrown by \OC\LargeFileHelper.
Diffstat (limited to 'lib')
-rw-r--r--lib/private/largefilehelper.php9
1 files changed, 7 insertions, 2 deletions
diff --git a/lib/private/largefilehelper.php b/lib/private/largefilehelper.php
index 4bab197b2ee..293e09fe2c9 100644
--- a/lib/private/largefilehelper.php
+++ b/lib/private/largefilehelper.php
@@ -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) {