From: Thomas Müller <thomas.mueller@tmit.eu>
Date: Wed, 18 Sep 2013 20:22:51 +0000 (+0200)
Subject: updating php docs
X-Git-Tag: v6.0.0alpha2~121^2~14^2
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=1274d6116dc59a8238ad9d02d467260387fe2eac;p=nextcloud-server.git

updating php docs
---

diff --git a/lib/cache.php b/lib/cache.php
index a4fa8be710c..a311f10a00f 100644
--- 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 b7f1b67a6d3..9b7e837e1bc 100644
--- 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 aac3b39af33..baa8820700b 100644
--- 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 202459f7c24..436ee71b2b9 100644
--- 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 3dcf39f7d60..8fefa25f65d 100644
--- 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;