Added some comments to teh Email Interface so that auto suggest works…

… better in IDEs
rikh42 · Mar 10, 2013 · 4a8a65c · 4a8a65c
1 parent 597b332
commit 4a8a65c
Showing 1 changed file with 59 additions and 0 deletions.
diff --git a/email/EmailInterface.php b/email/EmailInterface.php
@@ -10,16 +10,75 @@
 
 interface EmailInterface
 {
+    /**
+     * @param $subject
+     * @return EmailInterface
+     */
     public function subject($subject);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function to($email, $name=null);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function cc($email, $name=null);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function bcc($email, $name=null);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function from($email, $name=null);
+
+    /**
+     * @param $email
+     * @param null $name
+     * @return EmailInterface
+     */
     public function replyTo($email, $name = null);
+
+    /**
+     * @param $html
+     * @return EmailInterface
+     */
     public function htmlBody($html);
+
+    /**
+     * @param $plain
+     * @return EmailInterface
+     */
     public function textBody($plain);
+
+    /**
+     * @param $filename
+     * @param string $mime
+     * @return EmailInterface
+     */
     public function attach($filename, $mime='application/octet-stream');
+
+    /**
+     * @param $tag
+     * @return EmailInterface
+     */
     public function tag($tag);
+
+    /**
+     * @return bool
+     */
     public function send();
 
     public function getHtmlBody();