From a8d0ab00bcc8cc00ad3c47e42d86831d93534cca Mon Sep 17 00:00:00 2001 From: Michael M Slusarz Date: Thu, 24 Dec 2009 01:12:53 -0700 Subject: [PATCH] phpdoc --- imp/lib/Contents.php | 8 ++++---- imp/lib/Mailbox.php | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/imp/lib/Contents.php b/imp/lib/Contents.php index 535b16bba..59c9db1c2 100644 --- a/imp/lib/Contents.php +++ b/imp/lib/Contents.php @@ -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) diff --git a/imp/lib/Mailbox.php b/imp/lib/Mailbox.php index 9236877a3..d9986be4b 100644 --- a/imp/lib/Mailbox.php +++ b/imp/lib/Mailbox.php @@ -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) { -- 2.11.0