Improve phpdoc

diff --git a/apps/files_sharing/lib/cache.php b/apps/files_sharing/lib/cache.php
index 49b1d208d483b4380f83a27ef2365f03a0d7eae9..eeb62c3cce2c0c6f4348010cde2130163e1fcd94 100644 (file)
--- a/apps/files_sharing/lib/cache.php
+++ b/apps/files_sharing/lib/cache.php
@@ -400,6 +400,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 42fee4f336d802ee27e51244ff2718ce3a6c4ff7..1c9de56f8c5322879cef7a0a621f3e36fcb85fa0 100644 (file)
--- a/lib/private/files/cache/cache.php
+++ b/lib/private/files/cache/cache.php
@@ -594,7 +594,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
@@ -611,6 +611,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