Fixes DocBlocks in Zend_Mail

Closes #677
zendframework · Mar 16, 2016 · ba3e6fa · ba3e6fa
1 parent fccf5d2
commit ba3e6fa
Showing 1 changed file with 19 additions and 12 deletions.
diff --git a/library/Zend/Mail.php b/library/Zend/Mail.php
@@ -209,7 +209,6 @@ public static function clearDefaultTransport()
      * Public constructor
      *
      * @param  string $charset
-     * @return void
      */
     public function __construct($charset = null)
     {
@@ -329,8 +328,10 @@ public function setEncodingOfHeaders($encoding)
     /**
      * Set the encoding of mail headers
      *
-     * @param  string $encoding Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64
+     * @param  string $encoding Zend_Mime::ENCODING_QUOTEDPRINTABLE or
+     *                          Zend_Mime::ENCODING_BASE64
      * @return Zend_Mail Provides fluent interface
+     * @throws Zend_Mail_Exception
      */
     public function setHeaderEncoding($encoding)
     {
@@ -378,7 +379,8 @@ public function setBodyText($txt, $charset = null, $encoding = Zend_Mime::ENCODI
     /**
      * Return text body Zend_Mime_Part or string
      *
-     * @param  bool textOnly Whether to return just the body text content or the MIME part; defaults to false, the MIME part
+     * @param  bool $textOnly Whether to return just the body text content or
+     *                        the MIME part; defaults to false, the MIME part
      * @return false|Zend_Mime_Part|string
      */
     public function getBodyText($textOnly = false)
@@ -562,7 +564,8 @@ protected function _addRecipientAndHeader($headerName, $email, $name)
     }
 
     /**
-     * Adds To-header and recipient, $email can be an array, or a single string address
+     * Adds To-header and recipient, $email can be an array, or a single string
+     * address
      *
      * @param  string|array $email
      * @param  string $name
@@ -583,7 +586,8 @@ public function addTo($email, $name='')
     }
 
     /**
-     * Adds Cc-header and recipient, $email can be an array, or a single string address
+     * Adds Cc-header and recipient, $email can be an array, or a single string
+     * address
      *
      * @param  string|array    $email
      * @param  string    $name
@@ -763,8 +767,8 @@ public function clearReplyTo()
     /**
      * Sets Default From-email and name of the message
      *
-     * @param  string               $email
-     * @param  string    Optional   $name
+     * @param  string $email
+     * @param  string $name optional
      * @return void
      */
     public static function setDefaultFrom($email, $name = null)
@@ -796,6 +800,7 @@ public static function clearDefaultFrom()
      * Sets From-name and -email based on the defaults
      *
      * @return Zend_Mail Provides fluent interface
+     * @throws Zend_Mail_Exception
      */
     public function setFromToDefaultFrom() {
         $from = self::getDefaultFrom();
@@ -813,8 +818,8 @@ public function setFromToDefaultFrom() {
     /**
      * Sets Default ReplyTo-address and -name of the message
      *
-     * @param  string               $email
-     * @param  string    Optional   $name
+     * @param  string $email
+     * @param  string $name optional
      * @return void
      */
     public static function setDefaultReplyTo($email, $name = null)
@@ -846,6 +851,7 @@ public static function clearDefaultReplyTo()
      * Sets ReplyTo-name and -email based on the defaults
      *
      * @return Zend_Mail Provides fluent interface
+     * @throws Zend_Mail_Exception
      */
     public function setReplyToFromDefault() {
         $replyTo = self::getDefaultReplyTo();
@@ -961,9 +967,10 @@ public function clearSubject()
     /**
      * Sets Date-header
      *
-     * @param  timestamp|string|Zend_Date $date
+     * @param  int|string|Zend_Date $date
      * @return Zend_Mail Provides fluent interface
-     * @throws Zend_Mail_Exception if called subsequent times or wrong date format.
+     * @throws Zend_Mail_Exception if called subsequent times or wrong date
+     *                             format.
      */
     public function setDate($date = null)
     {
@@ -1153,7 +1160,7 @@ public function addHeader($name, $value, $append = false)
     /**
      * Return mail headers
      *
-     * @return void
+     * @return array
      */
     public function getHeaders()
     {