updating php docs

diff --git a/lib/cache.php b/lib/cache.php
index a4fa8be710c2c2ec4277215a9d1610857215ae27..a311f10a00fa4736136ab6a1e6bf3c5e3b7166d9 100644 (file)
--- a/lib/cache.php
+++ b/lib/cache.php
@@ -10,17 +10,17 @@ namespace OC;
 
 class Cache {
        /**
-        * @var OC_Cache $user_cache
+        * @var Cache $user_cache
         */
        static protected $user_cache;
        /**
-        * @var OC_Cache $global_cache
+        * @var Cache $global_cache
         */
        static protected $global_cache;
 
        /**
         * get the global cache
-        * @return OC_Cache
+        * @return Cache
         */
        static public function getGlobalCache() {
                if (!self::$global_cache) {
@@ -31,7 +31,7 @@ class Cache {
 
        /**
         * get the user cache
-        * @return OC_Cache
+        * @return Cache
         */
        static public function getUserCache() {
                if (!self::$user_cache) {
@@ -87,7 +87,7 @@ class Cache {
 
        /**
         * clear the user cache of all entries starting with a prefix
-        * @param string prefix (optional)
+        * @param string $prefix (optional)
         * @return bool
         */
        static public function clear($prefix='') {
@@ -95,6 +95,11 @@ class Cache {
                return $user_cache->clear($prefix);
        }
 
+       /**
+        * creates cache key based on the files given
+        * @param $files
+        * @return string
+        */
        static public function generateCacheKeyFromFiles($files) {
                $key = '';
                sort($files);

diff --git a/lib/cache/broker.php b/lib/cache/broker.php
index b7f1b67a6d34b815310111729588e3b6ac5db964..9b7e837e1bc96f4c4fbb32e2f607142438c23d8b 100644 (file)
--- a/lib/cache/broker.php
+++ b/lib/cache/broker.php
@@ -9,7 +9,15 @@
 namespace OC\Cache;
 
 class Broker {
+
+       /**
+        * @var \OC\Cache
+        */
        protected $fast_cache;
+
+       /**
+        * @var \OC\Cache
+        */
        protected $slow_cache;
 
        public function __construct($fast_cache, $slow_cache) {

diff --git a/lib/cache/usercache.php b/lib/cache/usercache.php
index aac3b39af33224b118a0cc6365086834151fbf65..baa8820700b9c652e0ed0e39bf4b1f008c61d26b 100644 (file)
--- a/lib/cache/usercache.php
+++ b/lib/cache/usercache.php
@@ -13,7 +13,7 @@ namespace OC\Cache;
 class UserCache implements \OCP\ICache {
 
        /**
-        * @var OC\Cache\File $userCache
+        * @var \OC\Cache\File $userCache
         */
        protected $userCache;
 
@@ -68,7 +68,7 @@ class UserCache implements \OCP\ICache {
 
        /**
         * clear the user cache of all entries starting with a prefix
-        * @param string prefix (optional)
+        * @param string $prefix (optional)
         * @return bool
         */
        public function clear($prefix = '') {

diff --git a/lib/public/icache.php b/lib/public/icache.php
index 202459f7c24001c4a3d3ba4b4d56f2e4f4a01920..436ee71b2b99e511fe239bda82d5c7d9bce50a6b 100644 (file)
--- a/lib/public/icache.php
+++ b/lib/public/icache.php
@@ -48,7 +48,7 @@ interface ICache {
 
        /**
         * clear the user cache of all entries starting with a prefix
-        * @param string prefix (optional)
+        * @param string $prefix (optional)
         * @return bool
         */
        public function clear($prefix = '');

diff --git a/tests/lib/cache.php b/tests/lib/cache.php
index 3dcf39f7d605df9b0c325264b25414c6f8d037e5..8fefa25f65d97f55468cd3835b33dd5031d30f3c 100644 (file)
--- a/tests/lib/cache.php
+++ b/tests/lib/cache.php
@@ -8,7 +8,7 @@
 
 abstract class Test_Cache extends PHPUnit_Framework_TestCase {
        /**
-        * @var OC_Cache cache;
+        * @var \OC\Cache cache;
         */
        protected $instance;