Expand doc blocks.

cakephp · May 23, 2013 · 85a906c · 85a906c
1 parent 11e428b
commit 85a906c
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/Cake/Network/Email/CakeEmail.php b/lib/Cake/Network/Email/CakeEmail.php
@@ -1026,6 +1026,16 @@ public function message($type = null) {
 /**
  * Configuration to use when send email
  *
+ * ### Usage
+ *
+ * Load configuration from `app/Config/email.php`:
+ *
+ * `$email->config('default');`
+ *
+ * Merge an array of configuration into the instance:
+ *
+ * `$email->config(array('to' => 'bill@example.com'));`
+ *
  * @param string|array $config String with configuration name (from email.php), array with config or null to return current config
  * @return string|array|CakeEmail
  */