phpdoc
authorMichael M Slusarz <slusarz@curecanti.org>
Thu, 24 Dec 2009 08:12:53 +0000 (01:12 -0700)
committerMichael M Slusarz <slusarz@curecanti.org>
Thu, 24 Dec 2009 09:07:25 +0000 (02:07 -0700)
imp/lib/Contents.php
imp/lib/Mailbox.php

index 535b16b..59c9db1 100644 (file)
@@ -99,8 +99,8 @@ class IMP_Contents
      * Ensures that only one IMP_Contents instance for any given message is
      * available at any one time.
      *
-     * @param mixed $in  Either a uid string (see IMP_Contents::singleton()
-     *                   for the format) or a Horde_Mime_Part object.
+     * @param mixed $in  Either a UID string (UID . IMP::IDX_SEP . Mailbox) or
+     *                   a Horde_Mime_Part object.
      *
      * @return IMP_Contents  The IMP_Contents object.
      * @throws Horde_Exception
@@ -121,8 +121,8 @@ class IMP_Contents
     /**
      * Constructor.
      *
-     * @param mixed $in  Either a uid string (see IMP_Contents::singleton()
-     *                   for the format) or a Horde_Mime_Part object.
+     * @param mixed $in  Either a UID string (UID . IMP::IDX_SEP . Mailbox) or
+     *                   a Horde_Mime_Part object.
      * @throws Horde_Exception
      */
     protected function __construct($in)
index 9236877..d9986be 100644 (file)
@@ -712,8 +712,8 @@ class IMP_Mailbox
      * @param integer $mbox  The message mailbox (defaults to the current
      *                       mailbox).
      *
-     * @return integer  The array index of the location of the message UID in
-     *                  the current mailbox.
+     * @return mixed  The array index of the location of the message UID in
+     *                the current mailbox. Returns null if not found.
      */
     public function getArrayIndex($uid, $mbox = null)
     {