Improve PHPDoc for memcache properties in ADOConnection

1 files changed, 24 insertions, 15 deletions

diff --git a/adodb.inc.php b/adodb.inc.php
index d8276ec0..2c6d6416 100644
--- a/adodb.inc.php
+++ b/adodb.inc.php
@@ -512,36 +512,45 @@ if (!defined('_ADODB_LAYER')) {
 	/*****************************************
 	* memcached server options
 	******************************************/
-	/*
-	 * Should we use memCache instead of caching in files
+
+	/**
+	 * Use memCache library instead of caching in files.
+	 * @var bool $memCache
 	 */
 	public $memCache = false;
-	/*
-	 * A string, array of hosts or array of memcache connection
-	 * options (see adodb.org)
+
+	/**
+	 * The memcache server(s) to connect to. Can be defined as:
+	 * - a single host name/ip address
+	 * - a list of hosts/ip addresses
+	 * - an array of server connection data (weighted server groups).
+	 * @link https://adodb.org/dokuwiki/doku.php?id=v5:userguide:memcached
+	 * @var string|array $memCacheHost
 	 */
 	public $memCacheHost;
 
-	/*
-	 * Default port, may be ignored if connection object array
-	 * is set
+	/**
+	 * Default port number.
+	 * The default port can be overridden if memcache server connection data
+	 * is provided as an array {@see $memCacheHost}.
+	 * @var int $memCachePort
 	 */
 	public $memCachePort = 11211;
 
-	/*
-	 * Use 'true' to store the item compressed
-	 * uses zlib, Direct option for memcache, else
-	 * For memcached, use the memcacheOptions feature
+	/**
+	 * Enable compression of stored items.
+	 * @var bool $memCacheCompress
 	 */
 	public $memCacheCompress = false;
 
-	/*
-	 * If using mecached, an array of options
+	/**
+	 * An array of memcached options.
+	 * Only used with memcached; memcache ignores this setting.
 	 * @link https://www.php.net/manual/en/memcached.constants.php
+	 * @var array $memCacheOptions
 	 */
 	public $memCacheOptions = array();
 
-
 	var $sysDate = false; /// name of function that returns the current date
 	var $sysTimeStamp = false; /// name of function that returns the current timestamp
 	var $sysUTimeStamp = false; // name of function that returns the current timestamp accurate to the microsecond or nearest fraction