Doc: Reformat @params declaration

I have not found documentation about the @params command, so this seems
not valid.
I have moved the text to the corresponding @param

Change-Id: I443866d602b60570278289e6e24a77d37314cede

diff --git a/includes/jobqueue/JobQueueFederated.php b/includes/jobqueue/JobQueueFederated.php
index d6f9560..01d7ec4 100644 (file)
--- a/includes/jobqueue/JobQueueFederated.php
+++ b/includes/jobqueue/JobQueueFederated.php
@@ -64,7 +64,7 @@ class JobQueueFederated extends JobQueue {
        const CACHE_TTL_LONG = 300; // integer; seconds to cache info that is kept up to date
 
        /**
-        * @params include:
+        * @param array $params Possible keys:
         *  - sectionsByWiki      : A map of wiki IDs to section names.
         *                          Wikis will default to using the section "default".
         *  - partitionsBySection : Map of section names to maps of (partition name => weight).
@@ -80,7 +80,6 @@ class JobQueueFederated extends JobQueue {
         *                          different partition queues. This improves availability
         *                          during failure, at the cost of added latency and somewhat
         *                          less reliable job de-duplication mechanisms.
-        * @param array $params
         * @throws MWException
         */
        protected function __construct( array $params ) {

diff --git a/includes/jobqueue/JobQueueRedis.php b/includes/jobqueue/JobQueueRedis.php
index 522bae1..3519eac 100644 (file)
--- a/includes/jobqueue/JobQueueRedis.php
+++ b/includes/jobqueue/JobQueueRedis.php
@@ -73,7 +73,7 @@ class JobQueueRedis extends JobQueue {
        protected $key;
 
        /**
-        * @params include:
+        * @param array $params Possible keys:
         *   - redisConfig : An array of parameters to RedisConnectionPool::__construct().
         *                   Note that the serializer option is ignored as "none" is always used.
         *   - redisServer : A hostname/port combination or the absolute path of a UNIX socket.
@@ -83,7 +83,6 @@ class JobQueueRedis extends JobQueue {
         *   - daemonized  : Set to true if the redisJobRunnerService runs in the background.
         *                   This will disable job recycling/undelaying from the MediaWiki side
         *                   to avoid redundance and out-of-sync configuration.
-        * @param array $params
         */
        public function __construct( array $params ) {
                parent::__construct( $params );

diff --git a/includes/jobqueue/aggregator/JobQueueAggregatorMemc.php b/includes/jobqueue/aggregator/JobQueueAggregatorMemc.php
index d733a42..ae266ef 100644 (file)
--- a/includes/jobqueue/aggregator/JobQueueAggregatorMemc.php
+++ b/includes/jobqueue/aggregator/JobQueueAggregatorMemc.php
@@ -34,11 +34,10 @@ class JobQueueAggregatorMemc extends JobQueueAggregator {
        protected $cacheTTL; // integer; seconds
 
        /**
-        * @params include:
+        * @param array $params Possible keys:
         *   - objectCache : Name of an object cache registered in $wgObjectCaches.
         *                   This defaults to the one specified by $wgMainCacheType.
         *   - cacheTTL    : Seconds to cache the aggregate data before regenerating.
-        * @param array $params
         */
        protected function __construct( array $params ) {
                parent::__construct( $params );

diff --git a/includes/jobqueue/aggregator/JobQueueAggregatorRedis.php b/includes/jobqueue/aggregator/JobQueueAggregatorRedis.php
index e8e8e30..db9e764 100644 (file)
--- a/includes/jobqueue/aggregator/JobQueueAggregatorRedis.php
+++ b/includes/jobqueue/aggregator/JobQueueAggregatorRedis.php
@@ -36,14 +36,13 @@ class JobQueueAggregatorRedis extends JobQueueAggregator {
        protected $servers;
 
        /**
-        * @params include:
+        * @param array $params Possible keys:
         *   - redisConfig  : An array of parameters to RedisConnectionPool::__construct().
         *   - redisServers : Array of server entries, the first being the primary and the
         *                    others being fallback servers. Each entry is either a hostname/port
         *                    combination or the absolute path of a UNIX socket.
         *                    If a hostname is specified but no port, the standard port number
         *                    6379 will be used. Required.
-        * @param array $params
         */
        protected function __construct( array $params ) {
                parent::__construct( $params );