[ticket/11230] Use inheritdoc in docblocks in cache drivers

http://tracker.phpbb.com/browse/PHPBB3-11230 PHPBB3-11230
author: Matt Friedman <maf675@gmail.com> 2014-03-19 20:31:55 -0700
committer: Matt Friedman <maf675@gmail.com> 2014-03-19 20:31:55 -0700
commit: 60e5757fa104c875de084fbb3740d97bafa19070 (patch)
tree: d00625dedd0d9c43114ad73a8448670fe6ba1061 /phpBB/phpbb/cache
parent: 82c8986aedf0b902d8db366a9eacf5fcabc2da72 (diff)
download: forums-60e5757fa104c875de084fbb3740d97bafa19070.tar
forums-60e5757fa104c875de084fbb3740d97bafa19070.tar.gz
forums-60e5757fa104c875de084fbb3740d97bafa19070.tar.bz2
forums-60e5757fa104c875de084fbb3740d97bafa19070.tar.xz
forums-60e5757fa104c875de084fbb3740d97bafa19070.zip
9 files changed, 55 insertions, 73 deletions
diff --git a/phpBB/phpbb/cache/driver/apc.php b/phpBB/phpbb/cache/driver/apc.php
index a28d91c00a..77b7b11181 100644
--- a/phpBB/phpbb/cache/driver/apc.php
+++ b/phpBB/phpbb/cache/driver/apc.php
@@ -18,9 +18,7 @@ class apc extends \phpbb\cache\driver\memory
 	var $extension = 'apc';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/eaccelerator.php b/phpBB/phpbb/cache/driver/eaccelerator.php
index 2629cb53e5..d1ad69ef6d 100644
--- a/phpBB/phpbb/cache/driver/eaccelerator.php
+++ b/phpBB/phpbb/cache/driver/eaccelerator.php
@@ -22,9 +22,7 @@ class eaccelerator extends \phpbb\cache\driver\memory
 	var $serialize_header = '#phpbb-serialized#';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -39,10 +37,8 @@ class eaccelerator extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	 * Perform cache garbage collection
-	 *
-	 * @return null
-	 */
+	* {@inheritDoc}
+	*/
 	function tidy()
 	{
 		eaccelerator_gc();
diff --git a/phpBB/phpbb/cache/driver/file.php b/phpBB/phpbb/cache/driver/file.php
index 6686da6953..e0f5d37af9 100644
--- a/phpBB/phpbb/cache/driver/file.php
+++ b/phpBB/phpbb/cache/driver/file.php
@@ -33,7 +33,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -41,7 +41,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -58,7 +58,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
@@ -93,7 +93,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -155,7 +155,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -177,7 +177,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 31536000)
 	{
@@ -194,7 +194,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -280,7 +280,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
@@ -359,7 +359,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -385,7 +385,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -431,7 +431,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -439,7 +439,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -452,7 +452,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -465,7 +465,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -479,7 +479,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
diff --git a/phpBB/phpbb/cache/driver/memcache.php b/phpBB/phpbb/cache/driver/memcache.php
index c725ec0fb0..eb3fced973 100644
--- a/phpBB/phpbb/cache/driver/memcache.php
+++ b/phpBB/phpbb/cache/driver/memcache.php
@@ -56,9 +56,7 @@ class memcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Unload the cache resources
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -68,9 +66,7 @@ class memcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/memory.php b/phpBB/phpbb/cache/driver/memory.php
index 292024212b..aab180f26a 100644
--- a/phpBB/phpbb/cache/driver/memory.php
+++ b/phpBB/phpbb/cache/driver/memory.php
@@ -50,7 +50,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -66,7 +66,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -81,7 +81,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
@@ -96,7 +96,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -106,7 +106,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -126,7 +126,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 2592000)
 	{
@@ -142,7 +142,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -183,7 +183,7 @@ abstract class memory extends \phpbb\cache\driver\base
 
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
@@ -237,7 +237,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -257,7 +257,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -335,7 +335,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -343,7 +343,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -356,7 +356,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -369,7 +369,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -383,7 +383,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
diff --git a/phpBB/phpbb/cache/driver/null.php b/phpBB/phpbb/cache/driver/null.php
index ea535ca1e1..8af63eb725 100644
--- a/phpBB/phpbb/cache/driver/null.php
+++ b/phpBB/phpbb/cache/driver/null.php
@@ -23,7 +23,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -31,21 +31,21 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -54,7 +54,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -62,28 +62,28 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 0)
 	{
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
 	}
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -91,7 +91,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -107,7 +107,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -115,7 +115,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -123,7 +123,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -131,7 +131,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -139,7 +139,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
diff --git a/phpBB/phpbb/cache/driver/redis.php b/phpBB/phpbb/cache/driver/redis.php
index 2b6f9bf36d..2f2a32a12d 100644
--- a/phpBB/phpbb/cache/driver/redis.php
+++ b/phpBB/phpbb/cache/driver/redis.php
@@ -92,9 +92,7 @@ class redis extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Unload the cache resources
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -104,9 +102,7 @@ class redis extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/wincache.php b/phpBB/phpbb/cache/driver/wincache.php
index 1f040e9ab2..d0f636d9cb 100644
--- a/phpBB/phpbb/cache/driver/wincache.php
+++ b/phpBB/phpbb/cache/driver/wincache.php
@@ -18,9 +18,7 @@ class wincache extends \phpbb\cache\driver\memory
 	var $extension = 'wincache';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/xcache.php b/phpBB/phpbb/cache/driver/xcache.php
index 4d0d683b3d..6c9323ec83 100644
--- a/phpBB/phpbb/cache/driver/xcache.php
+++ b/phpBB/phpbb/cache/driver/xcache.php
@@ -33,9 +33,7 @@ class xcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
author	Matt Friedman <maf675@gmail.com>	2014-03-19 20:31:55 -0700
committer	Matt Friedman <maf675@gmail.com>	2014-03-19 20:31:55 -0700
commit	60e5757fa104c875de084fbb3740d97bafa19070 (patch)
tree	d00625dedd0d9c43114ad73a8448670fe6ba1061 /phpBB/phpbb/cache
parent	82c8986aedf0b902d8db366a9eacf5fcabc2da72 (diff)
download	forums-60e5757fa104c875de084fbb3740d97bafa19070.tar forums-60e5757fa104c875de084fbb3740d97bafa19070.tar.gz forums-60e5757fa104c875de084fbb3740d97bafa19070.tar.bz2 forums-60e5757fa104c875de084fbb3740d97bafa19070.tar.xz forums-60e5757fa104c875de084fbb3740d97bafa19070.zip