phpdoc

diff --git a/framework/Core/lib/Horde/Core/Auth/Signup/Base.php b/framework/Core/lib/Horde/Core/Auth/Signup/Base.php
index 863b530..4ae78bb 100644 (file)
--- a/framework/Core/lib/Horde/Core/Auth/Signup/Base.php
+++ b/framework/Core/lib/Horde/Core/Auth/Signup/Base.php
@@ -20,8 +20,8 @@ abstract class Horde_Core_Auth_Signup_Base
      * Adds a new user to the system and handles any extra fields that may have
      * been compiled, relying on the hooks.php file.
      *
-     * @params mixed $info  Reference to array of parameters to be passed
-     *                      to hook.
+     * @param mixed $info  Reference to array of parameters to be passed
+     *                     to hook.
      *
      * @throws Horde_Exception
      */
@@ -44,8 +44,8 @@ abstract class Horde_Core_Auth_Signup_Base
     /**
      * Queues the user's submitted registration info for later admin approval.
      *
-     * @params mixed $info  Reference to array of parameters to be passed
-     *                      to hook
+     * @param mixed $info  Reference to array of parameters to be passed
+     *                     to hook.
      *
      * @throws Horde_Exception
      * @throws Horde_Mime_Exception
@@ -118,7 +118,7 @@ abstract class Horde_Core_Auth_Signup_Base
     /**
      * Queues the user's submitted registration info for later admin approval.
      *
-     * @params object $signup  Signup data.
+     * @param object $signup  Signup data.
      *
      * @throws Horde_Exception
      */

diff --git a/framework/Core/lib/Horde/Core/Auth/Signup/Null.php b/framework/Core/lib/Horde/Core/Auth/Signup/Null.php
index 6a10f8f..a6ee778 100644 (file)
--- a/framework/Core/lib/Horde/Core/Auth/Signup/Null.php
+++ b/framework/Core/lib/Horde/Core/Auth/Signup/Null.php
@@ -17,8 +17,8 @@ class Horde_Core_Auth_Signup_Null extends Horde_Core_Auth_Signup_Base
     /**
      * Queues the user's submitted registration info for later admin approval.
      *
-     * @params mixed $info  Reference to array of parameters to be passed
-     *                      to hook
+     * @param mixed $info  Reference to array of parameters to be passed
+     *                     to hook.
      */
     protected function _queueSignup(&$info)
     {

diff --git a/framework/Core/lib/Horde/Core/Auth/Signup/Sql.php b/framework/Core/lib/Horde/Core/Auth/Signup/Sql.php
index 53cb8f2..853077d 100644 (file)
--- a/framework/Core/lib/Horde/Core/Auth/Signup/Sql.php
+++ b/framework/Core/lib/Horde/Core/Auth/Signup/Sql.php
@@ -35,7 +35,7 @@ class Horde_Core_Auth_Signup_Sql extends Horde_Core_Auth_Signup_Base
     /**
      * Stores the signup data in the backend.
      *
-     * @params Horde_Core_Auth_Signup_SqlObject $signup  Signup data.
+     * @param Horde_Core_Auth_Signup_SqlObject $signup  Signup data.
      *
      * @throws Horde_Db_Exception
      */

diff --git a/framework/Core/lib/Horde/Core/Binder/Mapper.php b/framework/Core/lib/Horde/Core/Binder/Mapper.php
index 1cae6fb..107a81d 100644 (file)
--- a/framework/Core/lib/Horde/Core/Binder/Mapper.php
+++ b/framework/Core/lib/Horde/Core/Binder/Mapper.php
@@ -1,12 +1,13 @@
 <?php
+/**
+ * @category Horde
+ * @package  Core
+ */
 class Horde_Core_Binder_Mapper implements Horde_Injector_Binder
 {
     public function create(Horde_Injector $injector)
     {
-        $mapper = new Horde_Routes_Mapper();
-
-
-        return $mapper;
+        return new Horde_Routes_Mapper();
     }
 
     public function equals(Horde_Injector_Binder $binder)

diff --git a/framework/Core/lib/Horde/Core/Controller/NotFound.php b/framework/Core/lib/Horde/Core/Controller/NotFound.php
index d53f9c8..8f510bc 100644 (file)
--- a/framework/Core/lib/Horde/Core/Controller/NotFound.php
+++ b/framework/Core/lib/Horde/Core/Controller/NotFound.php
@@ -1,9 +1,14 @@
 <?php
+/**
+ * @category Horde
+ * @package  Core
+ */
 class Horde_Core_Controller_NotFound implements Horde_Controller
 {
     /**
      */
-    public function processRequest(Horde_Controller_Request $request, Horde_Controller_Response $response)
+    public function processRequest(Horde_Controller_Request $request,
+                                   Horde_Controller_Response $response)
     {
         $response->setHeader('HTTP/1.0 404 ', 'Not Found');
         $response->setBody('<h1>404 File Not Found</h1>');

diff --git a/framework/Core/lib/Horde/Core/Controller/RequestMapper.php b/framework/Core/lib/Horde/Core/Controller/RequestMapper.php
index ce93c7a..9906523 100644 (file)
--- a/framework/Core/lib/Horde/Core/Controller/RequestMapper.php
+++ b/framework/Core/lib/Horde/Core/Controller/RequestMapper.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @category Horde
+ * @package  Core
+ */
 class Horde_Core_Controller_RequestMapper
 {
     /**

diff --git a/framework/Core/lib/Horde/Core/Controller/SettingsFinder.php b/framework/Core/lib/Horde/Core/Controller/SettingsFinder.php
index 3b46e9a..94c6c19 100644 (file)
--- a/framework/Core/lib/Horde/Core/Controller/SettingsFinder.php
+++ b/framework/Core/lib/Horde/Core/Controller/SettingsFinder.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @category Horde
+ * @package  Core
+ */
 class Horde_Core_Controller_SettingsFinder
 {
     public function getSettingsExporterName($controllerName)

diff --git a/framework/Core/lib/Horde/Core/Factory/Request.php b/framework/Core/lib/Horde/Core/Factory/Request.php
index 599df1f..3224592 100644 (file)
--- a/framework/Core/lib/Horde/Core/Factory/Request.php
+++ b/framework/Core/lib/Horde/Core/Factory/Request.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * @category Horde
+ * @package  Core
  */
 class Horde_Core_Factory_Request
 {

diff --git a/framework/Core/lib/Horde/Core/Text/Filter/Bbcode.php b/framework/Core/lib/Horde/Core/Text/Filter/Bbcode.php
index c6c8ab3..8f92666 100644 (file)
--- a/framework/Core/lib/Horde/Core/Text/Filter/Bbcode.php
+++ b/framework/Core/lib/Horde/Core/Text/Filter/Bbcode.php
@@ -17,8 +17,8 @@ class Horde_Core_Text_Filter_Bbcode extends Horde_Text_Filter_Bbcode
     /**
      * Return link for use in getPatterns() regexp.
      *
-     * @var string $url    The URL.
-     * @var string $title  The link title.
+     * @param string $url    The URL.
+     * @param string $title  The link title.
      *
      * @return string  The opening <a> tag.
      */

diff --git a/framework/Core/lib/Horde/Registry.php b/framework/Core/lib/Horde/Registry.php
index 7b4913d..6293f43 100644 (file)
--- a/framework/Core/lib/Horde/Registry.php
+++ b/framework/Core/lib/Horde/Registry.php
@@ -1282,9 +1282,9 @@ implements Horde_Interfaces_Registry_Auth
     /**
      * Check permissions on an application.
      *
-     * @param string $app      The name of the application
-     * @param integer $perms   The permission level to check for.
-     * @params array $options  Additional options:
+     * @param string $app     The name of the application
+     * @param integer $perms  The permission level to check for.
+     * @param array $options  Additional options:
      * <pre>
      * 'notransparent' - (boolean) Do not attempt transparent authentication.
      *                   DEFAULT: false
@@ -1730,7 +1730,7 @@ implements Horde_Interfaces_Registry_Auth
      * isn't, but the configured Auth driver supports transparent
      * authentication, then we try that.
      *
-     * @params array $options  Additional options:
+     * @param array $options  Additional options:
      * <pre>
      * 'app' - (string) Check authentication for this app.
      *         DEFAULT: Checks horde-wide authentication.

diff --git a/framework/Imap_Client/lib/Horde/Imap/Client.php b/framework/Imap_Client/lib/Horde/Imap/Client.php
index 9982294..a6f8fac 100644 (file)
--- a/framework/Imap_Client/lib/Horde/Imap/Client.php
+++ b/framework/Imap_Client/lib/Horde/Imap/Client.php
@@ -3,66 +3,6 @@
  * Horde_Imap_Client:: provides an abstracted API interface to various IMAP
  * backends (RFC 3501).
  *
- * <pre>
- * Required Parameters:
- * --------------------
- * password - (string) The IMAP user password.
- * username - (string) The IMAP username.
- *
- * Optional Parameters:
- * --------------------
- * cache - (array) If set, caches data from fetch() calls. Requires
- *         Horde_Cache and Horde_Serialize to be installed. The array can
- *         contain the following keys (see Horde_Imap_Client_Cache:: for
- *         default values):
- *   cacheob - [REQUIRED] (Horde_Cache) The cache object to use.
- *   compress - [OPTIONAL] (string) Compression to use on the cached data.
- *                Either false, 'gzip' or 'lzf'.
- *   fields - [OPTIONAL] (array) The fetch criteria to cache. If not
- *              defined, all cacheable data is cached. The following is a list
- *              of criteria that can be cached:
- *                + Horde_Imap_Client::FETCH_DATE
- *                + Horde_Imap_Client::FETCH_ENVELOPE
- *                + Horde_Imap_Client::FETCH_FLAGS
- *                  Only if server supports CONDSTORE extension
- *                + Horde_Imap_Client::FETCH_HEADERS
- *                  Only for queries that specifically request caching
- *                + Horde_Imap_Client::FETCH_SIZE
- *                + Horde_Imap_Client::FETCH_STRUCTURE
- *   lifetime - [OPTIONAL] (integer) The lifetime of the cache data (in secs).
- *   slicesize - [OPTIONAL] (integer) The slicesize to use.
- * capability_ignore - (array) A list of IMAP capabilites to ignore, even if
- *                     they are supported on the server.
- *                     DEFAULT: No supported capabilities are ignored
- * comparator - (string) The search comparator to use instead of the default
- *              IMAP server comparator. See
- *              Horde_Imap_Client_Base::setComparator() for the format.
- *              DEFAULT: Use the server default
- * debug - (string) If set, will output debug information to the stream
- *         identified. The value can be any PHP supported wrapper that can
- *         be opened via fopen().
- *         DEFAULT: No debug output
- * hostspec - (string) The hostname or IP address of the server.
- *            DEFAULT: 'localhost'
- * id - (array) Send ID information to the IMAP server (only if server
- *      supports the ID extension). An array with the keys being the fields
- *      to send and the values being the associated values. See RFC 2971
- *      [3.3] for a list of defined field values.
- *      DEFAULT: No info sent to server
- * lang - (array) A list of languages (in priority order) to be used to
- *        display human readable messages.
- *        DEFAULT: Messages output in IMAP server default language
- * port - (integer) The server port to which we will connect.
- *         DEFAULT: 143 (imap or imap w/TLS) or 993 (imaps)
- * secure - (string) Use SSL or TLS to connect.
- *          VALUES: false, 'ssl', 'tls'.
- *          DEFAULT: No encryption
- * statuscache - (boolean) Cache STATUS responses?
- *               DEFAULT: False
- * timeout - (integer)  Connection timeout, in seconds.
- *           DEFAULT: 30 seconds
- * </pre>
- *
  * Copyright 2008-2010 The Horde Project (http://www.horde.org/)
  *
  * See the enclosed file COPYING for license information (LGPL). If you
@@ -172,13 +112,71 @@ class Horde_Imap_Client
      * Attempts to return a concrete Horde_Imap_Client instance based on
      * $driver.
      *
-     * @param string $driver  The type of concrete Horde_Imap_Client subclass
-     *                        to return.
-     * @param array $params   A hash containing any additional configuration or
-     *                        connection parameters a subclass might need.
+     * @param string $driver  The type of concrete subclass to return.
+     * @param array $params   Configuration parameters:
+     * <pre>
+     * Required Parameters:
+     * --------------------
+     * password - (string) The IMAP user password.
+     * username - (string) The IMAP username.
+     *
+     * Optional Parameters:
+     * --------------------
+     * cache - (array) If set, caches data from fetch() calls. Requires
+     *         Horde_Cache and Horde_Serialize to be installed. The array can
+     *         contain the following keys (see Horde_Imap_Client_Cache:: for
+     *         default values):
+     *   cacheob - [REQUIRED] (Horde_Cache) The cache object to use.
+     *   compress - [OPTIONAL] (string) Compression to use on the cached data.
+     *              VALUES: false, 'gzip' or 'lzf'.
+     *   fields - [OPTIONAL] (array) The fetch criteria to cache. If not
+     *            defined, all cacheable data is cached. The following is a
+     *            list of criteria that can be cached:
+     *              + Horde_Imap_Client::FETCH_DATE
+     *              + Horde_Imap_Client::FETCH_ENVELOPE
+     *              + Horde_Imap_Client::FETCH_FLAGS
+     *                Only if server supports CONDSTORE extension
+     *              + Horde_Imap_Client::FETCH_HEADERS
+     *                Only for queries that specifically request caching
+     *              + Horde_Imap_Client::FETCH_SIZE
+     *              + Horde_Imap_Client::FETCH_STRUCTURE
+     *   lifetime - [OPTIONAL] (integer) The lifetime of the cache data (in
+     *              seconds).
+     *   slicesize - [OPTIONAL] (integer) The slicesize to use.
+     *
+     * capability_ignore - (array) A list of IMAP capabilites to ignore, even
+     *                     if they are supported on the server.
+     *                     DEFAULT: No supported capabilities are ignored
+     * comparator - (string) The search comparator to use instead of the
+     *              default IMAP server comparator. See
+     *              Horde_Imap_Client_Base::setComparator() for the format.
+     *              DEFAULT: Use the server default
+     * debug - (string) If set, will output debug information to the stream
+     *         identified. The value can be any PHP supported wrapper that can
+     *         be opened via fopen().
+     *         DEFAULT: No debug output
+     * hostspec - (string) The hostname or IP address of the server.
+     *            DEFAULT: 'localhost'
+     * id - (array) Send ID information to the IMAP server (only if server
+     *      supports the ID extension). An array with the keys being the
+     *      fields to send and the values being the associated values. See RFC
+     *      2971 [3.3] for a list of defined field values.
+     *      DEFAULT: No info sent to server
+     * lang - (array) A list of languages (in priority order) to be used to
+     *        display human readable messages.
+     *        DEFAULT: Messages output in IMAP server default language
+     * port - (integer) The server port to which we will connect.
+     *         DEFAULT: 143 (imap or imap w/TLS) or 993 (imaps)
+     * secure - (string) Use SSL or TLS to connect.
+     *          VALUES: false, 'ssl', 'tls'.
+     *          DEFAULT: No encryption
+     * statuscache - (boolean) Cache STATUS responses?
+     *               DEFAULT: False
+     * timeout - (integer)  Connection timeout, in seconds.
+     *           DEFAULT: 30 seconds
+     * </pre>
      *
-     * @return Horde_Imap_Client_Base  The newly created Horde_Imap_Client
-     *                                 instance.
+     * @return Horde_Imap_Client_Base  The newly created instance.
      * @throws Horde_Imap_Client_Exception
      */
     static public function factory($driver, $params = array())

diff --git a/framework/Mime/lib/Horde/Mime.php b/framework/Mime/lib/Horde/Mime.php
index d0e292b..15f4a9a 100644 (file)
--- a/framework/Mime/lib/Horde/Mime.php
+++ b/framework/Mime/lib/Horde/Mime.php
@@ -360,7 +360,7 @@ class Horde_Mime
      *                            to.
      *
      * @return string  The decoded text.
-     * @throw Horde_Mime_Exception
+     * @throws Horde_Mime_Exception
      */
     static public function decodeAddrString($string, $to_charset = null)
     {

diff --git a/imp/lib/Imap/Tree.php b/imp/lib/Imap/Tree.php
index af6b5c4..5a2b53e 100644 (file)
--- a/imp/lib/Imap/Tree.php
+++ b/imp/lib/Imap/Tree.php
@@ -286,18 +286,18 @@ class IMP_Imap_Tree implements ArrayAccess, Iterator
 
     /**
      * Make a single mailbox tree element.
-     * An element consists of the following items (we use single letters here
-     * to save in session storage space):
-     *   'a'  --  Attributes
-     *   'c'  --  Level count
-     *   'l'  --  Label
-     *   'p'  --  Parent node
-     *   'v'  --  Value
      *
      * @param string $name         The mailbox name.
      * @param integer $attributes  The mailbox's attributes.
      *
-     * @return array  See above format.
+     * @return array  An array with the following keys (we use single letters
+     *                to save in session storage space):
+     * <pre>
+     * 'a' - (integer) Attributes mask.
+     * 'c' - (integer) Level count.
+     * 'l' - (string) Label.
+     * 'p' - (string) Parent node.
+     * 'v' - (string) Value.
      * @throws Horde_Exception
      */
     protected function _makeElt($name, $attributes = 0)