From e74ecaf307804e0f9d37c7842f9fbbd9f36ba8bb Mon Sep 17 00:00:00 2001
From: diosmosis <benakamoorthi@fastmail.fm>
Date: Sat, 19 Oct 2013 23:37:04 -0400
Subject: Refs #4200, documented Mail class.

---
 core/Mail.php | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

(limited to 'core/Mail.php')

diff --git a/core/Mail.php b/core/Mail.php
index a0a8ec8e5a..903d773fac 100644
--- a/core/Mail.php
+++ b/core/Mail.php
@@ -14,15 +14,16 @@ use Zend_Mail;
 
 /**
  * Class for sending mails, for more information see:
+ * [http://framework.zend.com/manual/en/zend.mail.html](#http://framework.zend.com/manual/en/zend.mail.html)
  *
  * @package Piwik
  * @see Zend_Mail, libs/Zend/Mail.php
- * @link http://framework.zend.com/manual/en/zend.mail.html
+ * @api
  */
 class Mail extends Zend_Mail
 {
     /**
-     * Default charset utf-8
+     * Constructor.
      *
      * @param string $charset charset, defaults to utf-8
      */
@@ -33,10 +34,10 @@ class Mail extends Zend_Mail
     }
 
     /**
-     * Sets the sender to use
+     * Sets the sender.
      *
-     * @param string $email
-     * @param null|string $name
+     * @param string $email Email address of the sender.
+     * @param null|string $name Name of the sender.
      * @return Zend_Mail
      */
     public function setFrom($email, $name = null)
@@ -82,4 +83,4 @@ class Mail extends Zend_Mail
         Mail::setDefaultTransport($tr);
         ini_set("smtp_port", $mailConfig['port']);
     }
-}
+}
\ No newline at end of file
-- 
cgit v1.2.3