From: Michael M Slusarz <slusarz@curecanti.org>
Date: Wed, 28 Oct 2009 21:52:44 +0000 (-0600)
Subject: Better @return description for getEmbeddedMimeParts()
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=0d9d0a2190dca10957d3dd00ba573b4a3267402e;p=horde.git

Better @return description for getEmbeddedMimeParts()
---

diff --git a/framework/Mime/lib/Horde/Mime/Viewer/Driver.php b/framework/Mime/lib/Horde/Mime/Viewer/Driver.php
index 816469ed8..c95c6248e 100644
--- a/framework/Mime/lib/Horde/Mime/Viewer/Driver.php
+++ b/framework/Mime/lib/Horde/Mime/Viewer/Driver.php
@@ -230,7 +230,9 @@ class Horde_Mime_Viewer_Driver
     public function embeddedMimeParts()
     {
         $viewer = $this->_getViewer();
-        return ($viewer) ? $viewer->embeddedMimeParts() : $this->_capability['embedded'];
+        return $viewer
+            ? $viewer->embeddedMimeParts()
+            : $this->_capability['embedded'];
     }
 
     /**
@@ -238,13 +240,15 @@ class Horde_Mime_Viewer_Driver
      * MIME parts exist, return a list of MIME parts that contain the embedded
      * MIME part information.
      *
-     * @return mixed  An array of Horde_Mime_Part objects, with the key as
-     *                the ID, or null if no embedded MIME parts exist.
+     * @return mixed  An array with MIME IDs as the keys and Horde_Mime_Part
+     *                objects as the parts to replace the current value of
+     *                the given MIME ID.
+     *                Returns null if no embedded MIME parts exist.
      */
     public function getEmbeddedMimeParts()
     {
         $viewer = $this->_getViewer();
-        return ($viewer)
+        return $viewer
             ? $viewer->getEmbeddedMimeParts()
             : $this->_getEmbeddedMimeParts();
     }
@@ -254,8 +258,10 @@ class Horde_Mime_Viewer_Driver
      * MIME parts exist, return a list of MIME parts that contain the embedded
      * MIME part information.
      *
-     * @return mixed  An array of Horde_Mime_Part objects, with the key as
-     *                the ID, or null if no embedded MIME parts exist.
+     * @return mixed  An array with MIME IDs as the keys and Horde_Mime_Part
+     *                objects as the parts to replace the current value of
+     *                the given MIME ID.
+     *                Returns null if no embedded MIME parts exist.
      */
     protected function _getEmbeddedMimeParts()
     {