aboutsummaryrefslogtreecommitdiffstats
path: root/includes/jobqueue/Job.php
diff options
context:
space:
mode:
authorumherirrender <umherirrender_de.wp@web.de>2014-04-20 23:33:05 +0200
committerumherirrender <umherirrender_de.wp@web.de>2014-04-20 23:33:05 +0200
commitdcf6955e5c7e5dd1aaf84b9fe207d0660fc577cd (patch)
tree0c12c4bba793973e38dfabbf9f0480342c5860d7 /includes/jobqueue/Job.php
parent79ebb4b0288b709fb53cff8f7ebc5f50221931c9 (diff)
downloadmediawikicore-dcf6955e5c7e5dd1aaf84b9fe207d0660fc577cd.tar.gz
mediawikicore-dcf6955e5c7e5dd1aaf84b9fe207d0660fc577cd.zip
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
Diffstat (limited to 'includes/jobqueue/Job.php')
-rw-r--r--includes/jobqueue/Job.php14
1 files changed, 7 insertions, 7 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
*/