From 187a1f6f30cc0eb2907e659892cf9ed34390dd4f Mon Sep 17 00:00:00 2001
From: Ingo Schommer <ingo@silverstripe.com>
Date: Tue, 17 Mar 2009 20:20:08 +0000
Subject: [PATCH] MINOR documentation

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@73232 467b73ca-7a2a-4603-9d3b-597d59a354a9
---
 email/Email.php  |  3 +++
 email/Mailer.php | 24 ++++++++++++------------
 2 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/email/Email.php b/email/Email.php
index 1bf8773cf..86e72d306 100755
--- a/email/Email.php
+++ b/email/Email.php
@@ -233,6 +233,9 @@ class Email extends ViewableData {
 	/**
 	 * Add a custom header to this value.
 	 * Useful for implementing all those cool features that we didn't think of.
+	 * 
+	 * @param string $headerName
+	 * @param string $headerValue
 	 */
 	public function addCustomHeader($headerName, $headerValue) {
 		if($headerName == 'Cc') $this->cc = $headerValue;
diff --git a/email/Mailer.php b/email/Mailer.php
index 456fcd1d6..1b0e451c3 100644
--- a/email/Mailer.php
+++ b/email/Mailer.php
@@ -1,21 +1,21 @@
 <?php
 /**
+ * Mailer objects are responsible for actually sending emails.
+ * The default Mailer class will use PHP's mail() function.
+ * 
  * @package sapphire
  * @subpackage email
  */
-
-/**
- * Mailer objects are responsible for actually sending emails.
- * The default Mailer class will use PHP's mail() fun
- * However, it 
- * One Email::set_mailer();
- * 
- * @TODO complete the description above
- */
 class Mailer extends Object {
 	/**
 	 * Send a plain-text email.
-	 * 
+	 *  
+	 * @param string $to
+	 * @param string $from
+	 * @param string §subject
+	 * @param string $plainContent
+	 * @param bool $attachedFiles
+	 * @param array $customheaders
 	 * @return bool
 	 */
 	function sendPlain($to, $from, $subject, $plainContent, $attachedFiles = false, $customheaders = false) {
@@ -127,7 +127,7 @@ function htmlEmail($to, $from, $subject, $htmlContent, $attachedFiles = false, $
 	}
 
 	// Email headers
-	$headers["From"] 		= validEmailAddr($from);
+	$headers["From"] = validEmailAddr($from);
 
 	// Messages with the X-SilverStripeMessageID header can be tracked
     if(isset($customheaders["X-SilverStripeMessageID"]) && defined('BOUNCE_EMAIL')) {
@@ -319,7 +319,7 @@ function wrapImagesInline_rewriter($url) {
 }
 
 /*
- * Combine headers w/ the body into a single string
+ * Combine headers w/ the body into a single string.
  */
 function processHeaders($headers, $body = false) {
 	$res = '';