[Pkg-owncloud-commits] [owncloud] 93/134: Improve phpdoc

[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 6dd3215eae9b7190fb774ef49973355493376f22
Author: Robin Appelman <icewind at owncloud.com>
Date:   Mon Mar 31 14:29:55 2014 +0200

    Improve phpdoc
---
 apps/files_sharing/lib/cache.php  | 7 +++++++
 lib/private/files/cache/cache.php | 4 +++-
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/apps/files_sharing/lib/cache.php b/apps/files_sharing/lib/cache.php
index f733e04..ee31da1 100644
--- a/apps/files_sharing/lib/cache.php
+++ b/apps/files_sharing/lib/cache.php
@@ -393,6 +393,13 @@ class Shared_Cache extends Cache {
 		return false;
 	}
 
+	/**
+	 * get the path of a file on this storage by it's id
+	 *
+	 * @param int $id
+	 * @param string $pathEnd (optional) used internally for recursive calls
+	 * @return string | null
+	 */
 	public function getPathById($id, $pathEnd = '') {
 		// direct shares are easy
 		if ($path = $this->getShareById($id)) {
diff --git a/lib/private/files/cache/cache.php b/lib/private/files/cache/cache.php
index 03616cb..b5e27d6 100644
--- a/lib/private/files/cache/cache.php
+++ b/lib/private/files/cache/cache.php
@@ -580,7 +580,7 @@ class Cache {
 	}
 
 	/**
-	 * get the storage id of the storage for a file and the internal path of the file
+	 * get the path of a file on this storage by it's id
 	 *
 	 * @param int $id
 	 * @return string | null
@@ -597,6 +597,8 @@ class Cache {
 
 	/**
 	 * get the storage id of the storage for a file and the internal path of the file
+	 * unlike getPathById this does not limit the search to files on this storage and
+	 * instead does a global search in the cache table
 	 *
 	 * @param int $id
 	 * @return array, first element holding the storage id, second the path

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