Fixed some @params documentation (includes/*)

Swapped some "$var type" to "type $var" or added missing types
before the $var. Changed some other types to match the more common
spelling. Makes beginning of some text in captial.

Change-Id: Ifbb1da2a6278b0bde2a6f6ce2e7bd383ee3fb28a

9 files changed, 38 insertions, 38 deletions

diff --git a/includes/jobqueue/Job.php b/includes/jobqueue/Job.php
index 5fc1e0644ccc..3456373042f9 100644
--- a/includes/jobqueue/Job.php
+++ b/includes/jobqueue/Job.php
@@ -87,7 +87,7 @@ abstract class Job implements IJobSpecification {
 	 * This may add duplicate at insert time, but they will be
 	 * removed later on, when the first one is popped.
 	 *
-	 * @param array $jobs of Job objects
+	 * @param array $jobs Array of Job objects
 	 * @return bool
 	 * @deprecated since 1.21
 	 */
@@ -102,7 +102,7 @@ abstract class Job implements IJobSpecification {
 	 * be rolled-back as part of a larger transaction. However,
 	 * large batches of jobs can cause slave lag.
 	 *
-	 * @param array $jobs of Job objects
+	 * @param array $jobs Array of Job objects
 	 * @return bool
 	 * @deprecated since 1.21
 	 */
@@ -115,7 +115,7 @@ abstract class Job implements IJobSpecification {
 	 * actually find a job; it may be adversely affected by concurrent job
 	 * runners.
 	 *
-	 * @param $type string
+	 * @param string $type
 	 * @return Job|bool Returns false if there are no jobs
 	 * @deprecated since 1.21
 	 */
@@ -139,9 +139,9 @@ abstract class Job implements IJobSpecification {
 	 *------------------------------------------------------------------------*/
 
 	/**
-	 * @param $command
-	 * @param $title
-	 * @param $params array|bool
+	 * @param string $command
+	 * @param Title $title
+	 * @param array|bool $params
 	 */
 	public function __construct( $command, $title, $params = false ) {
 		$this->command = $command;
@@ -199,7 +199,7 @@ abstract class Job implements IJobSpecification {
 	}
 
 	/**
-	 * @return integer Number of actually "work items" handled in this job
+	 * @return int Number of actually "work items" handled in this job
 	 * @see $wgJobBackoffThrottling
 	 * @since 1.23
 	 */
diff --git a/includes/jobqueue/JobQueue.php b/includes/jobqueue/JobQueue.php
index 9b13aea2d896..c858e42fd9d8 100644
--- a/includes/jobqueue/JobQueue.php
+++ b/includes/jobqueue/JobQueue.php
@@ -344,7 +344,7 @@ abstract class JobQueue {
 	/**
 	 * @see JobQueue::batchPush()
 	 * @param array $jobs
-	 * @param $flags
+	 * @param array $flags
 	 */
 	abstract protected function doBatchPush( array $jobs, $flags );
 
diff --git a/includes/jobqueue/JobQueueDB.php b/includes/jobqueue/JobQueueDB.php
index 5f1ca14eff1f..1991bb49ff3a 100644
--- a/includes/jobqueue/JobQueueDB.php
+++ b/includes/jobqueue/JobQueueDB.php
@@ -189,7 +189,7 @@ class JobQueueDB extends JobQueue {
 	/**
 	 * @see JobQueue::doBatchPush()
 	 * @param array $jobs
-	 * @param $flags
+	 * @param array $flags
 	 * @throws DBError|Exception
 	 * @return bool
 	 */
@@ -338,7 +338,7 @@ class JobQueueDB extends JobQueue {
 	 * Reserve a row with a single UPDATE without holding row locks over RTTs...
 	 *
 	 * @param string $uuid 32 char hex string
-	 * @param $rand integer Random unsigned integer (31 bits)
+	 * @param int $rand Random unsigned integer (31 bits)
 	 * @param bool $gte Search for job_random >= $random (otherwise job_random <= $random)
 	 * @return stdClass|bool Row|false
 	 */
@@ -774,7 +774,7 @@ class JobQueueDB extends JobQueue {
 	}
 
 	/**
-	 * @param $index integer (DB_SLAVE/DB_MASTER)
+	 * @param int $index (DB_SLAVE/DB_MASTER)
 	 * @return DBConnRef
 	 */
 	protected function getDB( $index ) {
@@ -786,7 +786,7 @@ class JobQueueDB extends JobQueue {
 	}
 
 	/**
-	 * @param $property
+	 * @param string $property
 	 * @return string
 	 */
 	private function getCacheKey( $property ) {
@@ -797,7 +797,7 @@ class JobQueueDB extends JobQueue {
 	}
 
 	/**
-	 * @param $params
+	 * @param array|bool $params
 	 * @return string
 	 */
 	protected static function makeBlob( $params ) {
@@ -809,7 +809,7 @@ class JobQueueDB extends JobQueue {
 	}
 
 	/**
-	 * @param $blob
+	 * @param string $blob
 	 * @return bool|mixed
 	 */
 	protected static function extractBlob( $blob ) {
diff --git a/includes/jobqueue/JobQueueFederated.php b/includes/jobqueue/JobQueueFederated.php
index 05ded4eb0d0e..9d46a00c859a 100644
--- a/includes/jobqueue/JobQueueFederated.php
+++ b/includes/jobqueue/JobQueueFederated.php
@@ -555,7 +555,7 @@ class JobQueueFederated extends JobQueue {
 	}
 
 	/**
-	 * @param $property
+	 * @param string $property
 	 * @return string
 	 */
 	private function getCacheKey( $property ) {
diff --git a/includes/jobqueue/JobQueueGroup.php b/includes/jobqueue/JobQueueGroup.php
index 65912829d66f..948baa01d75f 100644
--- a/includes/jobqueue/JobQueueGroup.php
+++ b/includes/jobqueue/JobQueueGroup.php
@@ -254,7 +254,7 @@ class JobQueueGroup {
 	/**
 	 * Check if there are any queues with jobs (this is cached)
 	 *
-	 * @param integer $type JobQueueGroup::TYPE_* constant
+	 * @param int $type JobQueueGroup::TYPE_* constant
 	 * @return bool
 	 * @since 1.23
 	 */
@@ -414,7 +414,7 @@ class JobQueueGroup {
 	}
 
 	/**
-	 * @param $name string
+	 * @param string $name
 	 * @return mixed
 	 */
 	private function getCachedConfigVar( $name ) {
diff --git a/includes/jobqueue/JobQueueRedis.php b/includes/jobqueue/JobQueueRedis.php
index 135a61d3148a..f5a266e03e71 100644
--- a/includes/jobqueue/JobQueueRedis.php
+++ b/includes/jobqueue/JobQueueRedis.php
@@ -194,7 +194,7 @@ class JobQueueRedis extends JobQueue {
 	/**
 	 * @see JobQueue::doBatchPush()
 	 * @param array $jobs
-	 * @param $flags
+	 * @param array $flags
 	 * @return bool
 	 * @throws JobQueueError
 	 */
@@ -350,7 +350,7 @@ LUA;
 
 	/**
 	 * @param RedisConnRef $conn
-	 * @return array serialized string or false
+	 * @return array Serialized string or false
 	 * @throws RedisException
 	 */
 	protected function popAndDeleteBlob( RedisConnRef $conn ) {
@@ -383,7 +383,7 @@ LUA;
 
 	/**
 	 * @param RedisConnRef $conn
-	 * @return array serialized string or false
+	 * @return array Serialized string or false
 	 * @throws RedisException
 	 */
 	protected function popAndAcquireBlob( RedisConnRef $conn ) {
@@ -614,8 +614,8 @@ LUA;
 	/**
 	 * This function should not be called outside JobQueueRedis
 	 *
-	 * @param $uid string
-	 * @param $conn RedisConnRef
+	 * @param string $uid
+	 * @param RedisConnRef $conn
 	 * @return Job|bool Returns false if the job does not exist
 	 * @throws MWException|JobQueueError
 	 */
@@ -773,7 +773,7 @@ LUA;
 	}
 
 	/**
-	 * @param $fields array
+	 * @param array $fields
 	 * @return Job|bool
 	 */
 	protected function getJobFromFields( array $fields ) {
@@ -840,8 +840,8 @@ LUA;
 	}
 
 	/**
-	 * @param $conn RedisConnRef
-	 * @param $e RedisException
+	 * @param RedisConnRef $conn
+	 * @param RedisException $e
 	 * @throws JobQueueError
 	 */
 	protected function throwRedisException( RedisConnRef $conn, $e ) {
@@ -850,8 +850,8 @@ LUA;
 	}
 
 	/**
-	 * @param $prop string
-	 * @param $type string|null
+	 * @param string $prop
+	 * @param string|null $type
 	 * @return string
 	 */
 	private function getQueueKey( $prop, $type = null ) {
@@ -865,7 +865,7 @@ LUA;
 	}
 
 	/**
-	 * @param $key string
+	 * @param string $key
 	 * @return void
 	 */
 	public function setTestingPrefix( $key ) {
diff --git a/includes/jobqueue/jobs/DoubleRedirectJob.php b/includes/jobqueue/jobs/DoubleRedirectJob.php
index 94b56ef73369..34c302e90030 100644
--- a/includes/jobqueue/jobs/DoubleRedirectJob.php
+++ b/includes/jobqueue/jobs/DoubleRedirectJob.php
@@ -42,9 +42,9 @@ class DoubleRedirectJob extends Job {
 
 	/**
 	 * Insert jobs into the job queue to fix redirects to the given title
-	 * @param string $reason the reason for the fix, see message
+	 * @param string $reason The reason for the fix, see message
 	 *   "double-redirect-fixed-<reason>"
-	 * @param $redirTitle Title: the title which has changed, redirects
+	 * @param Title $redirTitle The title which has changed, redirects
 	 *   pointing to this title are fixed
 	 * @param bool $destTitle Not used
 	 */
@@ -177,9 +177,9 @@ class DoubleRedirectJob extends Job {
 	/**
 	 * Get the final destination of a redirect
 	 *
-	 * @param $title Title
+	 * @param Title $title
 	 *
-	 * @return bool if the specified title is not a redirect, or if it is a circular redirect
+	 * @return bool If the specified title is not a redirect, or if it is a circular redirect
 	 */
 	public static function getFinalDestination( $title ) {
 		$dbw = wfGetDB( DB_MASTER );
diff --git a/includes/jobqueue/jobs/RefreshLinksJob2.php b/includes/jobqueue/jobs/RefreshLinksJob2.php
index 1a27e1f62f11..97405aeb63f8 100644
--- a/includes/jobqueue/jobs/RefreshLinksJob2.php
+++ b/includes/jobqueue/jobs/RefreshLinksJob2.php
@@ -37,7 +37,7 @@ class RefreshLinksJob2 extends Job {
 
 	/**
 	 * Run a refreshLinks2 job
-	 * @return boolean success
+	 * @return bool Success
 	 */
 	function run() {
 		global $wgUpdateRowsPerJob;
@@ -101,9 +101,9 @@ class RefreshLinksJob2 extends Job {
 	}
 
 	/**
-	 * @param $table string
-	 * @param $masterPos mixed
-	 * @return Array
+	 * @param string $table
+	 * @param mixed $masterPos
+	 * @return array
 	 */
 	protected function getSingleTitleJobs( $table, $masterPos ) {
 		# The "start"/"end" fields are not set for the base jobs
@@ -128,7 +128,7 @@ class RefreshLinksJob2 extends Job {
 	}
 
 	/**
-	 * @return Array
+	 * @return array
 	 */
 	public function getDeduplicationInfo() {
 		$info = parent::getDeduplicationInfo();
diff --git a/includes/jobqueue/jobs/UploadFromUrlJob.php b/includes/jobqueue/jobs/UploadFromUrlJob.php
index 2cdac57e5e2c..480246b09a52 100644
--- a/includes/jobqueue/jobs/UploadFromUrlJob.php
+++ b/includes/jobqueue/jobs/UploadFromUrlJob.php
@@ -174,7 +174,7 @@ class UploadFromUrlJob extends Job {
 	}
 
 	/**
-	 * @param $key
+	 * @param string $key
 	 * @return mixed
 	 */
 	public static function &getSessionData( $key ) {