Indented multi-line docs for readability.

pear2 · Apr 28, 2013 · 24c44f5 · 24c44f5
1 parent 1694385
commit 24c44f5
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 51 deletions.
diff --git a/src/PEAR2/Cache/SHM.php b/src/PEAR2/Cache/SHM.php
@@ -79,9 +79,10 @@ public static function isMeetingRequirements()
      * Registers an SHM adapter, allowing you to call it with {@link factory()}.
      * 
      * @param string $adapter FQCN of adapter. A valid adapter is one that
-     * extends this class. The class will be autoloaded if not already present.
+     *     extends this class. The class will be autoloaded if not already
+     *     present.
      * @param bool   $prepend Whether to prepend this adapter into the list of
-     * possible adapters, instead of appending to it.
+     *     possible adapters, instead of appending to it.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -112,7 +113,7 @@ final public static function registerAdapter($adapter, $prepend = false)
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Seconds to store the value. If set to 0 indicates no
-     * time limit.
+     *     time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -192,20 +193,20 @@ public function __unset($key)
      * Estabilishes a separate persistent storage.
      * 
      * @param string $persistentId The ID for the storage. The storage will be
-     * reused if it exists, or created if it doesn't exist. Data and locks are
-     * namespaced by this ID.
+     *     reused if it exists, or created if it doesn't exist. Data and locks
+     *     are namespaced by this ID.
      */
     abstract public function __construct($persistentId);
 
     /**
      * Obtains a named lock.
      * 
      * @param string $key     Name of the key to obtain. Note that $key may
-     * repeat for each distinct $persistentId.
+     *     repeat for each distinct $persistentId.
      * @param double $timeout If the lock can't be immediatly obtained, the
-     * script will block for at most the specified amount of seconds. Setting
-     * this to 0 makes lock obtaining non blocking, and setting it to NULL makes
-     * it block without a time limit.
+     *     script will block for at most the specified amount of seconds.
+     *     Setting this to 0 makes lock obtaining non blocking, and setting it
+     *     to NULL makes it block without a time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -215,7 +216,7 @@ abstract public function lock($key, $timeout = null);
      * Releases a named lock.
      * 
      * @param string $key Name of the key to release. Note that $key may
-     * repeat for each distinct $persistentId.
+     *     repeat for each distinct $persistentId.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -238,7 +239,7 @@ abstract public function exists($key);
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Seconds to store the value. If set to 0 indicates no
-     * time limit.
+     *     time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -252,7 +253,7 @@ abstract public function add($key, $value, $ttl = 0);
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Seconds to store the value. If set to 0 indicates no
-     * time limit.
+     *     time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */

diff --git a/src/PEAR2/Cache/SHM/Adapter/APC.php b/src/PEAR2/Cache/SHM/Adapter/APC.php
@@ -54,7 +54,7 @@ class APC extends SHM
 
     /**
      * @var array Array of lock names (as values) for each persistent ID (as
-     * key) obtained during the current request.
+     *     key) obtained during the current request.
      */
     protected static $locksBackup = array();
 
@@ -64,8 +64,8 @@ class APC extends SHM
      * Estabilishes a separate persistent storage.
      * 
      * @param string $persistentId The ID for the storage. The storage will be
-     * reused if it exists, or created if it doesn't exist. Data and locks are
-     * namespaced by this ID.
+     *     reused if it exists, or created if it doesn't exist. Data and locks
+     *     are namespaced by this ID.
      */
     public function __construct($persistentId)
     {
@@ -104,9 +104,9 @@ public static function isMeetingRequirements()
      * are no objects left in the current request using the same persistent ID.
      * 
      * @param string $internalPersistentId The internal persistent ID, the locks
-     * of which are being released.
+     *     of which are being released.
      * @param bool   $isAtShutdown         Whether the function was executed at
-     * shutdown.
+     *     shutdown.
      * 
      * @return void
      * @internal
@@ -136,11 +136,11 @@ public function __destruct()
      * Obtains a named lock.
      * 
      * @param string $key     Name of the key to obtain. Note that $key may
-     * repeat for each distinct $persistentId.
+     *     repeat for each distinct $persistentId.
      * @param double $timeout If the lock can't be immediatly obtained, the
-     * script will block for at most the specified amount of seconds. Setting
-     * this to 0 makes lock obtaining non blocking, and setting it to NULL makes
-     * it block without a time limit.
+     *     script will block for at most the specified amount of seconds.
+     *     Setting this to 0 makes lock obtaining non blocking, and setting it
+     *     to NULL makes it block without a time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -162,7 +162,7 @@ public function lock($key, $timeout = null)
      * Releases a named lock.
      * 
      * @param string $key Name of the key to release. Note that $key may
-     * repeat for each distinct $persistentId.
+     *     repeat for each distinct $persistentId.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -201,7 +201,7 @@ public function exists($key)
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Seconds to store the value. If set to 0 indicates no
-     * time limit.
+     *     time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -218,7 +218,7 @@ public function add($key, $value, $ttl = 0)
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Seconds to store the value. If set to 0 indicates no
-     * time limit.
+     *     time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -366,14 +366,14 @@ public function clear()
      * Returns an external iterator.
      * 
      * @param string $filter   A PCRE regular expression. Only matching keys
-     * will be iterated over. Setting this to NULL matches all keys of this
-     * instance.
+     *     will be iterated over. Setting this to NULL matches all keys of this
+     *     instance.
      * @param bool   $keysOnly Whether to return only the keys, or return both
-     * the keys and values.
+     *     the keys and values.
      * 
      * @return array An array with all matching keys as array keys, and values
-     * as array values. If $keysOnly is TRUE, the array keys are numeric, and
-     * the array values are key names.
+     *     as array values. If $keysOnly is TRUE, the array keys are numeric,
+     *     and the array values are key names.
      */
     public function getIterator($filter = null, $keysOnly = false)
     {

diff --git a/src/PEAR2/Cache/SHM/Adapter/Placebo.php b/src/PEAR2/Cache/SHM/Adapter/Placebo.php
@@ -55,7 +55,7 @@ class Placebo extends SHM
 
     /**
      * @var array Array of lock names (as values) for each persistent ID (as
-     * key) obtained during the current request.
+     *     key) obtained during the current request.
      */
     protected static $locksBackup = array();
 
@@ -76,8 +76,8 @@ class Placebo extends SHM
      * Estabilishes a separate persistent storage.
      * 
      * @param string $persistentId The ID for the storage. The storage will be
-     * reused if it exists, or created if it doesn't exist. Data and locks are
-     * namespaced by this ID.
+     *     reused if it exists, or created if it doesn't exist. Data and locks
+     *     are namespaced by this ID.
      */
     public function __construct($persistentId)
     {
@@ -170,7 +170,7 @@ public function exists($key)
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Because "true" adapters purge the cache at the next
-     * request, this setting is ignored.
+     *     request, this setting is ignored.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -190,7 +190,7 @@ public function add($key, $value, $ttl = 0)
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Because "true" adapters purge the cache at the next
-     * request, this setting is ignored.
+     *     request, this setting is ignored.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -323,14 +323,14 @@ public function clear()
      * Returns an external iterator.
      * 
      * @param string $filter   A PCRE regular expression. Only matching keys
-     * will be iterated over. Setting this to NULL matches all keys of this
-     * instance.
+     *     will be iterated over. Setting this to NULL matches all keys of this
+     *     instance.
      * @param bool   $keysOnly Whether to return only the keys, or return both
-     * the keys and values.
+     *     the keys and values.
      * 
      * @return array An array with all matching keys as array keys, and values
-     * as array values. If $keysOnly is TRUE, the array keys are numeric, and
-     * the array values are key names.
+     *     as array values. If $keysOnly is TRUE, the array keys are numeric,
+     *     and the array values are key names.
      */
     public function getIterator($filter = null, $keysOnly = false)
     {

diff --git a/src/PEAR2/Cache/SHM/Adapter/Wincache.php b/src/PEAR2/Cache/SHM/Adapter/Wincache.php
@@ -62,8 +62,8 @@ class Wincache extends SHM
      * Estabilishes a separate persistent storage.
      * 
      * @param string $persistentId The ID for the storage. The storage will be
-     * reused if it exists, or created if it doesn't exist. Data and locks are
-     * namespaced by this ID.
+     *     reused if it exists, or created if it doesn't exist. Data and locks
+     *     are namespaced by this ID.
      */
     public function __construct($persistentId)
     {
@@ -126,9 +126,9 @@ public function __destruct()
      * Obtains a named lock.
      * 
      * @param string $key     Name of the key to obtain. Note that $key may
-     * repeat for each distinct $persistentId.
+     *     repeat for each distinct $persistentId.
      * @param double $timeout Ignored with WinCache. Script will always block if
-     * the lock can't be immediatly obtained.
+     *     the lock can't be immediatly obtained.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -147,7 +147,7 @@ public function lock($key, $timeout = null)
      * Releases a named lock.
      * 
      * @param string $key Name of the key to release. Note that $key may
-     * repeat for each distinct $persistentId.
+     *     repeat for each distinct $persistentId.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -186,7 +186,7 @@ public function exists($key)
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Seconds to store the value. If set to 0 indicates no
-     * time limit.
+     *     time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -203,7 +203,7 @@ public function add($key, $value, $ttl = 0)
      * @param string $key   Name of key to associate the value with.
      * @param mixed  $value Value for the specified key.
      * @param int    $ttl   Seconds to store the value. If set to 0 indicates no
-     * time limit.
+     *     time limit.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -344,14 +344,14 @@ public function clear()
      * Returns an external iterator.
      * 
      * @param string $filter   A PCRE regular expression. Only matching keys
-     * will be iterated over. Setting this to NULL matches all keys of this
-     * instance.
+     *     will be iterated over. Setting this to NULL matches all keys of this
+     *     instance.
      * @param bool   $keysOnly Whether to return only the keys, or return both
-     * the keys and values.
+     *     the keys and values.
      * 
      * @return array An array with all matching keys as array keys, and values
-     * as array values. If $keysOnly is TRUE, the array keys are numeric, and
-     * the array values are key names.
+     *     as array values. If $keysOnly is TRUE, the array keys are numeric,
+     *     and the array values are key names.
      */
     public function getIterator($filter = null, $keysOnly = false)
     {