[Pkg-owncloud-commits] [owncloud] 136/199: Document exceptions thrown by \OC\LargeFileHelper.

[David Prévot]

This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository owncloud.

commit 2929d19c7f0b87d8207cbeff35607b8c27674ebf
Author: Andreas Fischer <bantu at owncloud.com>
Date:   Sun Mar 16 20:05:06 2014 +0100

    Document exceptions thrown by \OC\LargeFileHelper.
---
 lib/private/largefilehelper.php | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/lib/private/largefilehelper.php b/lib/private/largefilehelper.php
index 4bab197..293e09f 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) {

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud.git