CRM add missing comment blocks
[civicrm-core.git] / CRM / Mailing / MailStore.php
index ee9e8dd5fac24111f5d9033fced094550aa9b252..c7f2ce5a0cfc9723a28a4b868e5218dc6b0f29a1 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -39,8 +39,9 @@ class CRM_Mailing_MailStore {
   /**
    * Return the proper mail store implementation, based on config settings
    *
-   * @param  string $name  name of the settings set from civimail_mail_settings to use (null for default)
+   * @param  string $name name of the settings set from civimail_mail_settings to use (null for default)
    *
+   * @throws Exception
    * @return object        mail store implementation for processing CiviMail-bound emails
    */
   function getStore($name = NULL) {
@@ -135,8 +136,9 @@ class CRM_Mailing_MailStore {
   /**
    * Point to (and create if needed) a local Maildir for storing retrieved mail
    *
-   * @param string $name  name of the Maildir
+   * @param string $name name of the Maildir
    *
+   * @throws Exception
    * @return string       path to the Maildir's cur directory
    */
   function maildir($name) {