phpdoc

horde · Feb 25, 2014 · b6686fc · b6686fc
1 parent e68b9ac
commit b6686fc
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 0 deletions.
diff --git a/framework/Cache/lib/Horde/Cache.php b/framework/Cache/lib/Horde/Cache.php
@@ -45,11 +45,13 @@ class Horde_Cache
      *
      * @param Horde_Cache_Storage $storage  The storage object.
      * @param array $params                 Parameter array:
+     * <pre>
      *   - compress: (boolean) Compress data (if possible)?
      *               DEFAULT: false
      *   - lifetime: (integer) Lifetime of data, in seconds.
      *               DEFAULT: 86400 seconds
      *   - logger: (Horde_Log_Logger) Log object to use for log/debug messages.
+     * </pre>
      */
     public function __construct(Horde_Cache_Storage_Base $storage,
                                 array $params = array())

diff --git a/framework/Cache/lib/Horde/Cache/Storage/Apc.php b/framework/Cache/lib/Horde/Cache/Storage/Apc.php
@@ -31,8 +31,10 @@ class Horde_Cache_Storage_Apc extends Horde_Cache_Storage_Base
      * Constructor.
      *
      * @param array $params  Optional parameters:
+     * <pre>
      *   - prefix: (string) The prefix to use for the cache keys.
      *             DEFAULT: ''
+     * </pre>
      */
     public function __construct(array $params = array())
     {

diff --git a/framework/Cache/lib/Horde/Cache/Storage/Eaccelerator.php b/framework/Cache/lib/Horde/Cache/Storage/Eaccelerator.php
@@ -26,8 +26,10 @@ class Horde_Cache_Storage_Eaccelerator extends Horde_Cache_Storage_Base
      * Constructor.
      *
      * @param array $params  Optional parameters:
+     * <pre>
      *   - prefix: (string) The prefix to use for the cache keys.
      *             DEFAULT: ''
+     * </pre>
      *
      * @throws Horde_Cache_Exception
      */

diff --git a/framework/Cache/lib/Horde/Cache/Storage/Memcache.php b/framework/Cache/lib/Horde/Cache/Storage/Memcache.php
@@ -43,9 +43,11 @@ class Horde_Cache_Storage_Memcache extends Horde_Cache_Storage_Base
      * Construct a new Horde_Cache_Memcache object.
      *
      * @param array $params  Parameter array:
+     * <pre>
      *   - memcache: (Horde_Memcache) [REQUIRED] A Horde_Memcache object.
      *   - prefix: (string) The prefix to use for the cache keys.
      *             DEFAULT: ''
+     * </pre>
      */
     public function __construct(array $params = array())
     {

diff --git a/framework/Cache/lib/Horde/Cache/Storage/Mongo.php b/framework/Cache/lib/Horde/Cache/Storage/Mongo.php
@@ -39,8 +39,10 @@ class Horde_Cache_Storage_Mongo extends Horde_Cache_Storage_Base
      * Constructor.
      *
      * @param array $params  Parameters:
+     * <pre>
      *   - collection: (string) The collection name.
      *   - mongo_db: [REQUIRED] (Horde_Mongo_Client) A MongoDB client object.
+     * </pre>
      */
     public function __construct(array $params = array())
     {

diff --git a/framework/Cache/lib/Horde/Cache/Storage/Session.php b/framework/Cache/lib/Horde/Cache/Storage/Session.php
@@ -33,8 +33,10 @@ class Horde_Cache_Storage_Session extends Horde_Cache_Storage_Base
      * Constructor.
      *
      * @param array $params  Optional parameters:
+     * <pre>
      *   - session: (string) Store session data in this entry.
      *              DEFAULT: 'horde_cache_session'
+     * </pre>
      */
     public function __construct(array $params = array())
     {

diff --git a/framework/Cache/lib/Horde/Cache/Storage/Sql.php b/framework/Cache/lib/Horde/Cache/Storage/Sql.php
@@ -49,9 +49,11 @@ class Horde_Cache_Storage_Sql extends Horde_Cache_Storage_Base
      * Constructor.
      *
      * @param array $params  Parameters:
+     * <pre>
      *   - db: (Horde_Db_Adapter) [REQUIRED] The DB instance.
      *   - table: (string) The name of the cache table.
      *            DEFAULT: 'horde_cache'
+     * </pre>
      */
     public function __construct($params = array())
     {

diff --git a/framework/Cache/lib/Horde/Cache/Storage/Stack.php b/framework/Cache/lib/Horde/Cache/Storage/Stack.php
@@ -35,9 +35,11 @@ class Horde_Cache_Storage_Stack extends Horde_Cache_Storage_Base
      * Constructor.
      *
      * @param array $params  Parameters:
+     * <pre>
      *   - stack: (array) [REQUIRED] An array of storage instances to loop
      *            through, in order of priority. The last entry is considered
      *            the 'master' driver, for purposes of writes.
+     * </pre>
      */
     public function __construct(array $params = array())
     {

diff --git a/framework/Cache/lib/Horde/Cache/Storage/Xcache.php b/framework/Cache/lib/Horde/Cache/Storage/Xcache.php
@@ -26,8 +26,10 @@ class Horde_Cache_Storage_Xcache extends Horde_Cache_Storage_Base
      * Constructor.
      *
      * @param array $params  Optional parameters:
+     * <pre>
      *   - prefix: (string) The prefix to use for the cache keys.
      *             DEFAULT: ''
+     * </pre>
      */
     public function __construct(array $params = array())
     {