Improved/added parameter documentation

Change-Id: Ie48852acb434f6b62fda0b13b13e076f833d8975

5 files changed, 36 insertions, 0 deletions

diff --git a/includes/filerepo/backend/lockmanager/DBLockManager.php b/includes/filerepo/backend/lockmanager/DBLockManager.php
index 0a0ba54182ee..c2a508581976 100644
--- a/includes/filerepo/backend/lockmanager/DBLockManager.php
+++ b/includes/filerepo/backend/lockmanager/DBLockManager.php
@@ -113,6 +113,8 @@ class DBLockManager extends LockManager {
 
 	/**
 	 * @see LockManager::doLock()
+	 * @param $paths array
+	 * @param $type int
 	 * @return Status
 	 */
 	protected function doLock( array $paths, $type ) {
@@ -164,6 +166,8 @@ class DBLockManager extends LockManager {
 
 	/**
 	 * @see LockManager::doUnlock()
+	 * @param $paths array
+	 * @param $type int
 	 * @return Status
 	 */
 	protected function doUnlock( array $paths, $type ) {
@@ -438,11 +442,21 @@ class MySqlLockManager extends DBLockManager {
 		self::LOCK_EX => self::LOCK_EX
 	);
 
+	/**
+	 * @param $lockDb string
+	 * @param $db DatabaseBase
+	 */
 	protected function initConnection( $lockDb, DatabaseBase $db ) {
 		# Let this transaction see lock rows from other transactions
 		$db->query( "SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;" );
 	}
 
+	/**
+	 * @param $lockDb string
+	 * @param $paths array
+	 * @param $type int
+	 * @return bool
+	 */
 	protected function doLockingQuery( $lockDb, array $paths, $type ) {
 		$db = $this->getConnection( $lockDb );
 		if ( !$db ) {
diff --git a/includes/filerepo/backend/lockmanager/FSLockManager.php b/includes/filerepo/backend/lockmanager/FSLockManager.php
index 21a3a4ed9cdd..4f3b9596ec18 100644
--- a/includes/filerepo/backend/lockmanager/FSLockManager.php
+++ b/includes/filerepo/backend/lockmanager/FSLockManager.php
@@ -62,6 +62,8 @@ class FSLockManager extends LockManager {
 
 	/**
 	 * @see LockManager::doLock()
+	 * @param $paths array
+	 * @param $type int
 	 * @return Status
 	 */
 	protected function doLock( array $paths, $type ) {
@@ -84,6 +86,8 @@ class FSLockManager extends LockManager {
 
 	/**
 	 * @see LockManager::doUnlock()
+	 * @param $paths array
+	 * @param $type int
 	 * @return Status
 	 */
 	protected function doUnlock( array $paths, $type ) {
@@ -190,6 +194,11 @@ class FSLockManager extends LockManager {
 		return $status;
 	}
 
+	/**
+	 * @param $path string
+	 * @param $handlesToClose array
+	 * @return Status
+	 */
 	private function closeLockHandles( $path, array $handlesToClose ) {
 		$status = Status::newGood();
 		foreach ( $handlesToClose as $handle ) {
@@ -203,6 +212,10 @@ class FSLockManager extends LockManager {
 		return $status;
 	}
 
+	/**
+	 * @param $path string
+	 * @return Status
+	 */
 	private function pruneKeyLockFiles( $path ) {
 		$status = Status::newGood();
 		if ( !count( $this->locksHeld[$path] ) ) {
diff --git a/includes/filerepo/backend/lockmanager/LSLockManager.php b/includes/filerepo/backend/lockmanager/LSLockManager.php
index 4f78ede54ea6..79102851c498 100644
--- a/includes/filerepo/backend/lockmanager/LSLockManager.php
+++ b/includes/filerepo/backend/lockmanager/LSLockManager.php
@@ -93,6 +93,8 @@ class LSLockManager extends LockManager {
 
 	/**
 	 * @see LockManager::doLock()
+	 * @param $paths array
+	 * @param $type int
 	 * @return Status
 	 */
 	protected function doLock( array $paths, $type ) {
@@ -146,6 +148,8 @@ class LSLockManager extends LockManager {
 
 	/**
 	 * @see LockManager::doUnlock()
+	 * @param $paths array
+	 * @param $type int
 	 * @return Status
 	 */
 	protected function doUnlock( array $paths, $type ) {
diff --git a/includes/filerepo/backend/lockmanager/LockManager.php b/includes/filerepo/backend/lockmanager/LockManager.php
index 8b3e229c60a1..e41c7770a7f3 100644
--- a/includes/filerepo/backend/lockmanager/LockManager.php
+++ b/includes/filerepo/backend/lockmanager/LockManager.php
@@ -195,6 +195,8 @@ class ScopedLock {
 class NullLockManager extends LockManager {
 	/**
 	 * @see LockManager::doLock()
+	 * @param $paths array
+	 * @param $type int
 	 * @return Status
 	 */
 	protected function doLock( array $paths, $type ) {
@@ -203,6 +205,8 @@ class NullLockManager extends LockManager {
 
 	/**
 	 * @see LockManager::doUnlock()
+	 * @param $paths array
+	 * @param $type int
 	 * @return Status
 	 */
 	protected function doUnlock( array $paths, $type ) {
diff --git a/includes/filerepo/backend/lockmanager/LockManagerGroup.php b/includes/filerepo/backend/lockmanager/LockManagerGroup.php
index 7caff6249879..b8308556c954 100644
--- a/includes/filerepo/backend/lockmanager/LockManagerGroup.php
+++ b/includes/filerepo/backend/lockmanager/LockManagerGroup.php
@@ -39,6 +39,7 @@ class LockManagerGroup {
 	protected $managers = array();
 
 	protected function __construct() {}
+
 	/**
 	 * @return LockManagerGroup
 	 */