INFRA-132 - CRM/Mailing - Convert single-line @param to multi-line

[civicrm-core.git] / CRM / Mailing / MailStore.php

diff --git a/CRM/Mailing/MailStore.php b/CRM/Mailing/MailStore.php
index 44740a7064efa01ee7cf707e5e7501c4db404a73..559bc2ff8c59a85d36fd687f7a853bb50366ad4a 100644 (file)
--- a/CRM/Mailing/MailStore.php
+++ b/CRM/Mailing/MailStore.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -39,7 +39,8 @@ 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
@@ -86,23 +87,24 @@ class CRM_Mailing_MailStore {
    *
    * @return array  array of ezcMail objects
    */
-  function allMails() {
+  public function allMails() {
     return $this->fetchNext(0);
   }
 
   /**
    * Expunge the messages marked for deletion; stub function to be redefined by IMAP store
    */
-  function expunge() {}
+  public function expunge() {}
 
   /**
    * Return the next X messages from the mail store
    *
-   * @param int $count  number of messages to fetch (0 to fetch all)
+   * @param int $count
+   *   Number of messages to fetch (0 to fetch all).
    *
    * @return array      array of ezcMail objects
    */
-  function fetchNext($count = 1) {
+  public function fetchNext($count = 1) {
     if (isset($this->_transport->options->uidReferencing) and $this->_transport->options->uidReferencing) {
       $offset = array_shift($this->_transport->listUniqueIdentifiers());
     }
@@ -139,12 +141,13 @@ 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) {
+  public function maildir($name) {
     $config = CRM_Core_Config::singleton();
     $dir = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $name;
     foreach (array(
@@ -161,4 +164,3 @@ class CRM_Mailing_MailStore {
     return $dir . DIRECTORY_SEPARATOR . 'cur';
   }
 }
-