Merge remote-tracking branch 'vsephpbb/ticket/11230' into develop-ascraeus

* vsephpbb/ticket/11230:
  [ticket/11230] Add missing last returns to dock block
  [ticket/11230] Update cache driver dock blocks
  [ticket/11230] Use inheritdoc in docblocks in cache drivers

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()
 	{

phpBB/phpbb/cache/driver/driver_interface.php

@@ -18,46 +18,73 @@ interface driver_interface
 {
 	/**
 	* Load global cache
+	*
+	* @return mixed False if an error was encountered, otherwise the data type of the cached data
 	*/
 	public function load();
 
 	/**
 	* Unload cache object
+	*
+	* @return null
 	*/
 	public function unload();
 
 	/**
 	* Save modified objects
+	*
+	* @return null
 	*/
 	public function save();
 
 	/**
 	* Tidy cache
+	*
+	* @return null
 	*/
 	public function tidy();
 
 	/**
 	* Get saved cache object
+	*
+	* @param string $var_name 		Cache key
+	* @return mixed 				False if an error was encountered, otherwise the saved cached object
 	*/
 	public function get($var_name);
 
 	/**
 	* Put data into cache
+	*
+	* @param string $var_name 		Cache key
+	* @param mixed $var 			Cached data to store
+	* @param int $ttl 				Time-to-live of cached data
+	* @return null
 	*/
 	public function put($var_name, $var, $ttl = 0);
 
 	/**
 	* Purge cache data
+	*
+	* @return null
 	*/
 	public function purge();
 
 	/**
 	* Destroy cache data
+	*
+	* @param string $var_name 		Cache key
+	* @param string $table 			Table name
+	* @return null
 	*/
 	public function destroy($var_name, $table = '');
 
 	/**
 	* Check if a given cache entry exists
+	*
+	* @param string $var_name 		Cache key
+	*
+	* @return bool 					True if cache file exists and has not expired.
+	*								False otherwise.
 	*/
 	public function _exists($var_name);
 

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();

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)
 	{
@@ -758,6 +758,10 @@ class file extends \phpbb\cache\driver\base
 
 	/**
 	* Removes/unlinks file
+	*
+	* @param string $filename Filename to remove
+	* @param bool $check Check file permissions
+	* @return bool True if the file was successfully removed, otherwise false
 	*/
 	function remove_file($filename, $check = false)
 	{

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()
 	{

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)
 	{
@@ -400,6 +400,10 @@ abstract class memory extends \phpbb\cache\driver\base
 
 	/**
 	* Removes/unlinks file
+	*
+	* @param string $filename Filename to remove
+	* @param bool $check Check file permissions
+	* @return bool True if the file was successfully removed, otherwise false
 	*/
 	function remove_file($filename, $check = false)
 	{

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)
 	{

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()
 	{

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()
 	{

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()
 	{