phpdoc; fix return value
authorMichael M Slusarz <slusarz@curecanti.org>
Wed, 24 Nov 2010 18:23:34 +0000 (11:23 -0700)
committerMichael M Slusarz <slusarz@curecanti.org>
Wed, 24 Nov 2010 18:50:10 +0000 (11:50 -0700)
imp/lib/Injector/Factory/MailboxList.php
imp/lib/Mailbox/List/Track.php

index 3ed83de..bb1cc33 100644 (file)
@@ -47,10 +47,11 @@ class IMP_Injector_Factory_MailboxList
     /**
      * Return the mailbox list instance.
      * For IMP/MIMP, returns an IMP_Mailbox_List_Track object.
-     * For DIMP, returns an IMP_Mailbox_List object.
+     * For DIMP/Mobile, returns an IMP_Mailbox_List object.
      *
      * @param string $mailbox       The mailbox name.
-     * @param IMP_Indices $indices  An indices object.
+     * @param IMP_Indices $indices  An indices object. Only used for 'imp' and
+     *                              'mimp' views.
      *
      * @return IMP_Mailbox_List  The singleton instance.
      * @throws IMP_Exception
index a829711..5d3561a 100644 (file)
@@ -79,8 +79,6 @@ class IMP_Mailbox_List_Track extends IMP_Mailbox_List
     /**
      * Using the preferences and the current mailbox, determines the messages
      * to view on the current page.
-     *
-     * @see buildMailboxPage()
      */
     public function buildMailboxPage($page = 0, $start = 0, $opts = array())
     {
@@ -127,10 +125,6 @@ class IMP_Mailbox_List_Track extends IMP_Mailbox_List
     }
 
     /**
-     * Determines if a rebuild is needed, and, if necessary, performs
-     * the rebuild.
-     *
-     * @param boolean $force  Force a rebuild?
      */
     protected function _rebuild($force = false)
     {
@@ -142,10 +136,6 @@ class IMP_Mailbox_List_Track extends IMP_Mailbox_List
     }
 
     /**
-     * Returns the current sorted array without the given messages.
-     *
-     * @param mixed $indices  An IMP_Indices object or true to remove all
-     *                        messages in the mailbox.
      */
     public function removeMsgs($indices)
     {
@@ -153,7 +143,11 @@ class IMP_Mailbox_List_Track extends IMP_Mailbox_List
             /* Update the current array index to its new position in the
              * message array. */
             $this->setIndex(0);
+
+            return true;
         }
+
+        return false;
     }
 
 }