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

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

diff --git a/CRM/Mailing/MailStore/Pop3.php b/CRM/Mailing/MailStore/Pop3.php
index 4fde61193b90da1568170b327fc172346a2902ba..bfe1f25fe0f6f2681c5727c81fc5e65429586349 100644 (file)
--- a/CRM/Mailing/MailStore/Pop3.php
+++ b/CRM/Mailing/MailStore/Pop3.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,26 +28,34 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
 
 require_once 'ezc/Base/src/ezc_bootstrap.php';
 require_once 'ezc/autoload/mail_autoload.php';
+
+/**
+ * Class CRM_Mailing_MailStore_Pop3
+ */
 class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore {
 
   /**
    * Connect to the supplied POP3 server and make sure the two mail dirs exist
    *
-   * @param string $host      host to connect to
-   * @param string $username  authentication username
-   * @param string $password  authentication password
-   * @param bool   $ssl       whether to use POP3 or POP3S
+   * @param string $host
+   *   Host to connect to.
+   * @param string $username
+   *   Authentication username.
+   * @param string $password
+   *   Authentication password.
+   * @param bool $ssl
+   *   Whether to use POP3 or POP3S.
    *
-   * @return void
+   * @return \CRM_Mailing_MailStore_Pop3
    */
-  function __construct($host, $username, $password, $ssl = TRUE) {
+  public function __construct($host, $username, $password, $ssl = TRUE) {
     if ($this->_debug) {
       print "connecting to $host and authenticating as $username\n";
     }
@@ -63,11 +71,12 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore {
   /**
    * Fetch the specified message to the local ignore folder
    *
-   * @param integer $nr  number of the message to fetch
+   * @param int $nr
+   *   Number of the message to fetch.
    *
    * @return void
    */
-  function markIgnored($nr) {
+  public function markIgnored($nr) {
     if ($this->_debug) {
       print "fetching message $nr and putting it in the ignored mailbox\n";
     }
@@ -80,11 +89,12 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore {
   /**
    * Fetch the specified message to the local processed folder
    *
-   * @param integer $nr  number of the message to fetch
+   * @param int $nr
+   *   Number of the message to fetch.
    *
    * @return void
    */
-  function markProcessed($nr) {
+  public function markProcessed($nr) {
     if ($this->_debug) {
       print "fetching message $nr and putting it in the processed mailbox\n";
     }
@@ -94,4 +104,3 @@ class CRM_Mailing_MailStore_Pop3 extends CRM_Mailing_MailStore {
     $this->_transport->delete($nr);
   }
 }
-