phpdoc
authorMichael M Slusarz <slusarz@curecanti.org>
Tue, 16 Nov 2010 20:22:20 +0000 (13:22 -0700)
committerMichael M Slusarz <slusarz@curecanti.org>
Tue, 16 Nov 2010 21:41:23 +0000 (14:41 -0700)
framework/Imap_Client/lib/Horde/Imap/Client/Base.php
imp/lib/Search/Filter/Builtin.php
imp/lib/Ui/Compose.php
turba/lib/Api.php

index bd1af07..b901278 100644 (file)
@@ -1465,12 +1465,13 @@ abstract class Horde_Imap_Client_Base implements Serializable
      *             DEFAULT: false (results cached, if possible)
      * 'results' - (array) The data to return. Consists of zero or more of the
      *                     following flags:
-     * Horde_Imap_Client::SORT_RESULTS_COUNT
-     * Horde_Imap_Client::SORT_RESULTS_MATCH (DEFAULT)
-     * Horde_Imap_Client::SORT_RESULTS_MAX
-     * Horde_Imap_Client::SORT_RESULTS_MIN
-     * Horde_Imap_Client::SORT_RESULTS_SAVE - (This option is currently meant
-     *   for internal use only)
+     *
+     *             Horde_Imap_Client::SORT_RESULTS_COUNT
+     *             Horde_Imap_Client::SORT_RESULTS_MATCH (DEFAULT)
+     *             Horde_Imap_Client::SORT_RESULTS_MAX
+     *             Horde_Imap_Client::SORT_RESULTS_MIN
+     *             Horde_Imap_Client::SORT_RESULTS_SAVE (This option is
+     *             currently meant for internal use only)
      * 'reverse' - (boolean) Sort the entire returned list of messages in
      *             reverse (i.e. descending) order.
      *             DEFAULT: Sorted in ascending order.
@@ -1479,18 +1480,20 @@ abstract class Horde_Imap_Client_Base implements Serializable
      * 'sort' - (array) Sort the returned list of messages. Multiple sort
      *          criteria can be specified. The following sort criteria
      *          are available:
-     * Horde_Imap_Client::SORT_ARRIVAL
-     * Horde_Imap_Client::SORT_CC
-     * Horde_Imap_Client::SORT_DATE
-     * Horde_Imap_Client::SORT_FROM
-     * Horde_Imap_Client::SORT_SEQUENCE
-     * Horde_Imap_Client::SORT_SIZE
-     * Horde_Imap_Client::SORT_SUBJECT
-     * Horde_Imap_Client::SORT_TO
-     * [On servers that support SORT=DISPLAY, these criteria are also
-     *  available:]
-     * Horde_Imap_Client::SORT_DISPLAYFROM
-     * Horde_Imap_Client::SORT_DISPLAYTO
+     *
+     *          Horde_Imap_Client::SORT_ARRIVAL
+     *          Horde_Imap_Client::SORT_CC
+     *          Horde_Imap_Client::SORT_DATE
+     *          Horde_Imap_Client::SORT_FROM
+     *          Horde_Imap_Client::SORT_SEQUENCE
+     *          Horde_Imap_Client::SORT_SIZE
+     *          Horde_Imap_Client::SORT_SUBJECT
+     *          Horde_Imap_Client::SORT_TO
+     *          [On servers that support SORT=DISPLAY, these criteria are also
+     *           available:]
+     *          Horde_Imap_Client::SORT_DISPLAYFROM
+     *          Horde_Imap_Client::SORT_DISPLAYTO
+     *
      *          Additionally, any sort criteria can be sorted in reverse order
      *          (instead of the default ascending order) by adding a
      *          Horde_Imap_Client::SORT_REVERSE element to the array directly
index 1a56933..44c5a6e 100644 (file)
@@ -26,8 +26,6 @@ abstract class IMP_Search_Filter_Builtin extends IMP_Search_Filter
      * Constructor.
      *
      * The 'add', 'id', 'label', and 'mboxes' parameters are ignored.
-     *
-     * @see __construct()
      */
     public function __construct(array $opts = array())
     {
index 56f1be8..e0fc957 100644 (file)
@@ -120,8 +120,8 @@ class IMP_Ui_Compose
      * Given an address input, parses the input to obtain the list of
      * addresses to use on the compose page.
      *
-     * @param string $addr   The value of the header string.
-     * @param array $opts  Additional options:
+     * @param string $addr  The value of the header string.
+     * @param array $opts   Additional options:
      * <pre>
      * 'addr_list' - (boolean) Return the list of address components?
      *               DEFAULT: false
index 4dc9e4b..9a669fb 100644 (file)
@@ -1310,7 +1310,8 @@ class Turba_Api extends Horde_Registry_Api
     }
 
     /**
-     * Retrieves a list of all possible values of a field in specified source(s).
+     * Retrieves a list of all possible values of a field in specified
+     * source(s).
      *
      * @param string $field   Field name to check
      * @param array $sources  Array containing the sources to look in
@@ -1493,7 +1494,7 @@ class Turba_Api extends Horde_Registry_Api
      * Search for clients
      *
      * @param array $names         The search filter values
-     * @param array $fields        The fields to serach in
+     * @param array $fields        The fields to search in
      * @param boolean $matchBegin  Match word boundaries only
      *
      * @return array  A hash containing the search results.