PHPDoc cleanup - consistent naming of integer and boolean types

undpyy · Jun 6, 2014 · 6365f4d · 6365f4d
1 parent 608c301
commit 6365f4d
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 68 deletions.
diff --git a/class.phpmailer.php b/class.phpmailer.php
@@ -1168,7 +1168,7 @@ protected function mailSend($header, $body)
     public function getSMTPInstance()
     {
         if (!is_object($this->smtp)) {
-            $this->smtp = new smtp;
+            $this->smtp = new SMTP;
         }
         return $this->smtp;
     }

diff --git a/class.pop3.php b/class.pop3.php
@@ -27,7 +27,7 @@
  * @author Jim Jagielski (jimjag) <jimjag@gmail.com>
  * @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
  */
-class pop3
+class POP3
 {
     /**
      * The POP3 PHPMailer Version number.
@@ -38,14 +38,14 @@ class pop3
 
     /**
      * Default POP3 port number.
-     * @type int
+     * @type integer
      * @access public
      */
     public $POP3_PORT = 110;
 
     /**
      * Default timeout in seconds.
-     * @type int
+     * @type integer
      * @access public
      */
     public $POP3_TIMEOUT = 30;
@@ -61,7 +61,7 @@ class pop3
     /**
      * Debug display level.
      * Options: 0 = no, 1+ = yes
-     * @type int
+     * @type integer
      * @access public
      */
     public $do_debug = 0;
@@ -75,14 +75,14 @@ class pop3
 
     /**
      * POP3 port number.
-     * @type int
+     * @type integer
      * @access public
      */
     public $port;
 
     /**
      * POP3 Timeout Value in seconds.
-     * @type int
+     * @type integer
      * @access public
      */
     public $tval;
@@ -110,7 +110,7 @@ class pop3
 
     /**
      * Are we connected?
-     * @type bool
+     * @type boolean
      * @access private
      */
     private $connected = false;
@@ -130,12 +130,12 @@ class pop3
     /**
      * Simple static wrapper for all-in-one POP before SMTP
      * @param $host
-     * @param bool $port
-     * @param bool $tval
+     * @param boolean $port
+     * @param boolean $tval
      * @param string $username
      * @param string $password
-     * @param int $debug_level
-     * @return bool
+     * @param integer $debug_level
+     * @return boolean
      */
     public static function popBeforeSmtp(
         $host,
@@ -155,12 +155,12 @@ public static function popBeforeSmtp(
      * appropriate for POP-before SMTP authorisation.
      * @access public
      * @param string $host
-     * @param bool|int $port
-     * @param bool|int $tval
+     * @param integer|boolean $port
+     * @param integer|boolean $tval
      * @param string $username
      * @param string $password
-     * @param int $debug_level
-     * @return bool
+     * @param integer $debug_level
+     * @return boolean
      */
     public function authorise($host, $port = false, $tval = false, $username = '', $password = '', $debug_level = 0)
     {
@@ -200,7 +200,7 @@ public function authorise($host, $port = false, $tval = false, $username = '', $
      * Connect to a POP3 server.
      * @access public
      * @param string $host
-     * @param bool|integer $port
+     * @param integer|boolean $port
      * @param integer $tval
      * @return boolean
      */