phpDoc: added $var name to @param

Author: dg

src/Bridges/CacheLatte/CacheMacro.php

@@ -93,10 +93,8 @@ public static function initRuntime(Latte\Runtime\Template $template)
 
 	/**
 	 * Starts the output cache. Returns Nette\Caching\OutputHelper object if buffering was started.
-	 * @param  Nette\Caching\IStorage
-	 * @param  string
-	 * @param  Nette\Caching\OutputHelper[]
-	 * @param  array
+	 * @param  string  $key
+	 * @param  Nette\Caching\OutputHelper[]  $parents
 	 * @return Nette\Caching\OutputHelper|\stdClass
 	 */
 	public static function createCache(Nette\Caching\IStorage $cacheStorage, $key, &$parents, array $args = null)
@@ -121,7 +119,7 @@ public static function createCache(Nette\Caching\IStorage $cacheStorage, $key, &
 
 	/**
 	 * Ends the output cache.
-	 * @param  Nette\Caching\OutputHelper[]
+	 * @param  Nette\Caching\OutputHelper[]  $parents
 	 * @return void
 	 */
 	public static function endCache(&$parents, array $args = null)

src/Caching/Cache.php

@@ -69,7 +69,7 @@ public function getNamespace()
 
 	/**
 	 * Returns new nested cache object.
-	 * @param  string
+	 * @param  string  $namespace
 	 * @return static
 	 */
 	public function derive($namespace)
@@ -81,7 +81,7 @@ public function derive($namespace)
 
 	/**
 	 * Reads the specified item from the cache or generate it.
-	 * @param  mixed
+	 * @param  mixed  $key
 	 * @return mixed
 	 */
 	public function load($key, callable $fallback = null)
@@ -98,7 +98,6 @@ public function load($key, callable $fallback = null)
 
 	/**
 	 * Reads multiple items from the cache.
-	 * @param  array
 	 * @return array
 	 */
 	public function bulkLoad(array $keys, callable $fallback = null)
@@ -155,10 +154,9 @@ public function bulkLoad(array $keys, callable $fallback = null)
 	 * - Cache::ITEMS => (array|string) cache items
 	 * - Cache::CONSTS => (array|string) cache items
 	 *
-	 * @param  mixed
-	 * @param  mixed
+	 * @param  mixed  $key
+	 * @param  mixed  $data
 	 * @return mixed  value itself
-	 * @throws Nette\InvalidArgumentException
 	 */
 	public function save($key, $data, array $dependencies = null)
 	{
@@ -241,7 +239,7 @@ private function completeDependencies($dp)
 
 	/**
 	 * Removes item from the cache.
-	 * @param  mixed
+	 * @param  mixed  $key
 	 * @return void
 	 */
 	public function remove($key)
@@ -306,7 +304,7 @@ public function wrap(callable $function, array $dependencies = null)
 
 	/**
 	 * Starts the output cache.
-	 * @param  mixed
+	 * @param  mixed  $key
 	 * @return OutputHelper|null
 	 */
 	public function start($key)
@@ -321,7 +319,7 @@ public function start($key)
 
 	/**
 	 * Generates internal cache key.
-	 * @param  mixed
+	 * @param  mixed  $key
 	 * @return string
 	 */
 	protected function generateKey($key)
@@ -335,10 +333,9 @@ protected function generateKey($key)
 
 	/**
 	 * Checks CALLBACKS dependencies.
-	 * @param  array
 	 * @return bool
 	 */
-	public static function checkCallbacks($callbacks)
+	public static function checkCallbacks(array $callbacks)
 	{
 		foreach ($callbacks as $callback) {
 			if (!call_user_func_array(array_shift($callback), $callback)) {
@@ -351,8 +348,8 @@ public static function checkCallbacks($callbacks)
 
 	/**
 	 * Checks CONSTS dependency.
-	 * @param  string
-	 * @param  mixed
+	 * @param  string  $const
+	 * @param  mixed  $value
 	 * @return bool
 	 */
 	private static function checkConst($const, $value)
@@ -363,8 +360,8 @@ private static function checkConst($const, $value)
 
 	/**
 	 * Checks FILES dependency.
-	 * @param  string
-	 * @param  int|null
+	 * @param  string  $file
+	 * @param  int|null  $time
 	 * @return bool
 	 */
 	private static function checkFile($file, $time)

src/Caching/IBulkReader.php

@@ -16,7 +16,6 @@ interface IBulkReader
 
 	/**
 	 * Reads from cache in bulk.
-	 * @param  string
 	 * @return array key => value pairs, missing items are omitted
 	 */
 	function bulkRead(array $keys);

src/Caching/IStorage.php

@@ -16,36 +16,35 @@ interface IStorage
 
 	/**
 	 * Read from cache.
-	 * @param  string
+	 * @param  string  $key
 	 * @return mixed
 	 */
 	function read($key);
 
 	/**
 	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
+	 * @param  string  $key
 	 * @return void
 	 */
 	function lock($key);
 
 	/**
 	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
+	 * @param  string  $key
+	 * @param  mixed  $data
 	 * @return void
 	 */
 	function write($key, $data, array $dependencies);
 
 	/**
 	 * Removes item from the cache.
-	 * @param  string
+	 * @param  string  $key
 	 * @return void
 	 */
 	function remove($key);
 
 	/**
 	 * Removes items from the cache by conditions.
-	 * @param  array  conditions
 	 * @return void
 	 */
 	function clean(array $conditions);

src/Caching/Storages/FileStorage.php

@@ -92,7 +92,6 @@ public function read($key)
 
 	/**
 	 * Verifies dependencies.
-	 * @param  array
 	 * @return bool
 	 */
 	private function verify(array $meta)
@@ -294,8 +293,8 @@ public function clean(array $conditions)
 
 	/**
 	 * Reads cache data from disk.
-	 * @param  string  file path
-	 * @param  int     lock mode
+	 * @param  string  $file
+	 * @param  int  $lock
 	 * @return array|null
 	 */
 	protected function readMetaAndLock($file, $lock)
@@ -325,7 +324,6 @@ protected function readMetaAndLock($file, $lock)
 
 	/**
 	 * Reads cache data from disk and closes cache file handle.
-	 * @param  array
 	 * @return mixed
 	 */
 	protected function readData(array $meta)
@@ -344,7 +342,7 @@ protected function readData(array $meta)
 
 	/**
 	 * Returns file name.
-	 * @param  string
+	 * @param  string  $key
 	 * @return string
 	 */
 	protected function getCacheFile($key)
@@ -359,8 +357,8 @@ protected function getCacheFile($key)
 
 	/**
 	 * Deletes and closes file.
-	 * @param  string
-	 * @param  resource
+	 * @param  string  $file
+	 * @param  resource  $handle
 	 * @return void
 	 */
 	private static function delete($file, $handle = null)

src/Caching/Storages/IJournal.php

@@ -16,15 +16,13 @@ interface IJournal
 
 	/**
 	 * Writes entry information into the journal.
-	 * @param  string
-	 * @param  array
+	 * @param  string  $key
 	 * @return void
 	 */
 	function write($key, array $dependencies);
 
 	/**
 	 * Cleans entries from journal.
-	 * @param  array
 	 * @return array|null of removed items or null when performing a full cleanup
 	 */
 	function clean(array $conditions);

src/Caching/Storages/SQLiteJournal.php

@@ -26,7 +26,7 @@ class SQLiteJournal implements IJournal
 
 
 	/**
-	 * @param  string
+	 * @param  string  $path
 	 */
 	public function __construct($path)
 	{