Moved some RedisConnectionPool docs to the factory function.
authorAaron Schulz <aschulz@wikimedia.org>
Mon, 18 Mar 2013 16:57:23 +0000 (09:57 -0700)
committerGerrit Code Review <gerrit@wikimedia.org>
Tue, 19 Mar 2013 11:15:57 +0000 (11:15 +0000)
Change-Id: I4183b96e123882de604de1484456abcd10091fb2

includes/clientpool/RedisConnectionPool.php

index 5c7c4f2..a15e80b 100644 (file)
@@ -55,14 +55,6 @@ class RedisConnectionPool {
        const SERVER_DOWN_TTL = 30; // integer; seconds to cache servers as "down"
 
        /**
-        * $options include:
-        *   - connectTimeout : The timeout for new connections, in seconds.
-        *                      Optional, default is 1 second.
-        *   - persistent     : Set this to true to allow connections to persist across
-        *                      multiple web requests. False by default.
-        *   - password       : The authentication password, will be sent to Redis in clear text.
-        *                      Optional, if it is unspecified, no AUTH command will be sent.
-        *   - serializer     : Set to "php", "igbinary", or "none". Default is "php".
         * @param array $options
         */
        protected function __construct( array $options ) {
@@ -103,6 +95,14 @@ class RedisConnectionPool {
 
        /**
         * @param $options Array
+        * $options include:
+        *   - connectTimeout : The timeout for new connections, in seconds.
+        *                      Optional, default is 1 second.
+        *   - persistent     : Set this to true to allow connections to persist across
+        *                      multiple web requests. False by default.
+        *   - password       : The authentication password, will be sent to Redis in clear text.
+        *                      Optional, if it is unspecified, no AUTH command will be sent.
+        *   - serializer     : Set to "php", "igbinary", or "none". Default is "php".
         * @return RedisConnectionPool
         */
        public static function singleton( array $options ) {