No code changes, just cleanup

Fix some inconsistent phpdoc syntax, make sure scripts have a page-level docblock and version tags Remove compiled phpdocs from repo Add docs.ini config file for phpdoc: use `phpdoc -i docs.ini` to generate docs.
hellomagnus · Nov 12, 2008 · da06e1d · da06e1d
1 parent fb07adf
commit da06e1d
Show file tree

Hide file tree

Showing 17 changed files with 45 additions and 4,122 deletions.
diff --git a/class.phpmailer.php b/class.phpmailer.php
@@ -23,15 +23,23 @@
 | - Technology Consulting                                                   |
 | - Oursourcing (highly qualified programmers and graphic designers)        |
 '---------------------------------------------------------------------------'
+*/
 
 /**
  * PHPMailer - PHP email transport class
  * NOTE: Designed for use with PHP version 5 and up
  * @package PHPMailer
  * @author Andy Prevost
  * @copyright 2004 - 2008 Andy Prevost
+ * @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
+ * @version $Id$
  */
 
+/**
+ * PHPMailer - PHP email transport class
+ * @package PHPMailer
+ * @author Andy Prevost
+ */
 class PHPMailer {
 
   /////////////////////////////////////////////////
@@ -314,7 +322,7 @@ public function IsSendmail() {
    */
   public function IsQmail() {
     $this->Sendmail = '/var/qmail/bin/sendmail';
-    $this->Mailer   = 'sendmail';
+    $this->Mailer = 'sendmail';
   }
 
   /////////////////////////////////////////////////
@@ -510,11 +518,12 @@ public function MailSend($header, $body) {
   }
 
   /**
-   * Sends mail via SMTP using PhpSMTP (Author:
-   * Chris Ryan).  Returns bool.  Returns false if there is a
-   * bad MAIL FROM, RCPT, or DATA input.
+   * Sends mail via SMTP using PhpSMTP
+   * Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
+   * @uses SMTP
    * @access public
    * @return bool
+   * @author Chris Ryan
    */
   public function SmtpSend($header, $body) {
     include_once($this->PluginDir . 'class.smtp.php');
@@ -578,8 +587,9 @@ public function SmtpSend($header, $body) {
   }
 
   /**
-   * Initiates a connection to an SMTP server.  Returns false if the
-   * operation failed.
+   * Initiates a connection to an SMTP server.
+   * Returns false if the operation failed.
+   * @uses SMTP
    * @access public
    * @return bool
    */
@@ -643,6 +653,7 @@ public function SmtpConnect() {
 
   /**
    * Closes the active SMTP session if one exists.
+   * @uses SMTP
    * @return void
    */
   public function SmtpClose() {
@@ -1711,7 +1722,7 @@ public function AddCustomHeader($custom_header) {
    * @access public
    * @return $message
    */
-  public function MsgHTML($message,$basedir='') {
+  public function MsgHTML($message, $basedir = '') {
     preg_match_all("/(src|background)=\"(.*)\"/Ui", $message, $images);
     if(isset($images[2])) {
       foreach($images[2] as $i => $url) {

diff --git a/class.pop3.php b/class.pop3.php
@@ -23,6 +23,17 @@
 | - Technology Consulting                                                   |
 | - Oursourcing (highly qualified programmers and graphic designers)        |
 '---------------------------------------------------------------------------'
+*/
+
+/**
+ * PHPMailer - PHP POP Before SMTP Authentication Class
+ * NOTE: Designed for use with PHP version 5 and up
+ * @package PHPMailer
+ * @author Andy Prevost
+ * @copyright 2004 - 2008 Andy Prevost
+ * @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
+ * @version $Id$
+ */
 
 /**
  * POP Before SMTP Authentication Class

diff --git a/class.smtp.php b/class.smtp.php
@@ -23,6 +23,17 @@
 | - Technology Consulting                                                   |
 | - Oursourcing (highly qualified programmers and graphic designers)        |
 '---------------------------------------------------------------------------'
+*/
+
+/**
+ * PHPMailer - PHP SMTP email transport class
+ * NOTE: Designed for use with PHP version 5 and up
+ * @package PHPMailer
+ * @author Andy Prevost
+ * @copyright 2004 - 2008 Andy Prevost
+ * @license http://www.gnu.org/copyleft/lesser.html Distributed under the Lesser General Public License (LGPL)
+ * @version $Id$
+ */
 
 /**
  * SMTP is rfc 821 compliant and implements all the rfc 821 SMTP
@@ -96,7 +107,7 @@ public function __construct() {
    * @access public
    * @return bool
    */
-  public function Connect($host,$port=0,$tval=30) {
+  public function Connect($host, $port = 0, $tval = 30) {
     /* set the error val to null so there is no confusion */
     $this->error = null;
 
@@ -154,7 +165,7 @@ public function Connect($host,$port=0,$tval=30) {
   }
 
   /**
-   * Initiate a TSL communication with the server.
+   * Initiate a TLS communication with the server.
    *
    * SMTP CODE 220 Ready to start TLS
    * SMTP CODE 501 Syntax error (no parameters allowed)
@@ -520,7 +531,7 @@ public function Expand($name) {
    * @access public
    * @return bool
    */
-  public function Hello($host="") {
+  public function Hello($host = '') {
     $this->error = null; // so no confusion is caused
 
     if(!$this->connected()) {
@@ -594,7 +605,7 @@ private function SendHello($hello, $host) {
    * @access public
    * @return string
    */
-  public function Help($keyword="") {
+  public function Help($keyword = '') {
     $this->error = null; // to avoid confusion
 
     if(!$this->connected()) {
@@ -732,7 +743,7 @@ public function Noop() {
    * @access public
    * @return bool
    */
-  public function Quit($close_on_error=true) {
+  public function Quit($close_on_error = true) {
     $this->error = null; // so there is no confusion
 
     if(!$this->connected()) {