[geeklog-cvs] geeklog: Fixed phpDocumentor warnings

geeklog-cvs at lists.geeklog.net geeklog-cvs at lists.geeklog.net
Sat Mar 7 18:19:41 EST 2009


details:   http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/c9bc3cf73464
changeset: 6821:c9bc3cf73464
user:      Dirk Haun <dirk at haun-online.de>
date:      Sat Mar 07 17:16:51 2009 +0100
description:
Fixed phpDocumentor warnings

diffstat:

22 files changed, 103 insertions(+), 30 deletions(-)
plugins/spamx/BaseAdmin.class.php               |    6 ++----
plugins/spamx/BaseCommand.class.php             |    6 ++----
plugins/spamx/BlackList.Examine.class.php       |    3 ++-
plugins/spamx/DeleteComment.Action.class.php    |    2 ++
plugins/spamx/EditBlackList.Admin.class.php     |   11 ++++++++---
plugins/spamx/EditHeader.Admin.class.php        |    9 +++++++--
plugins/spamx/EditIP.Admin.class.php            |    9 +++++++--
plugins/spamx/EditIPofURL.Admin.class.php       |    9 +++++++--
plugins/spamx/Header.Examine.class.php          |    4 +++-
plugins/spamx/IP.Examine.class.php              |    4 +++-
plugins/spamx/IPofUrl.Examine.class.php         |    4 +++-
plugins/spamx/Import.Admin.class.php            |    9 +++++++++
plugins/spamx/LogView.Admin.class.php           |    9 +++++++++
plugins/spamx/MTBlackList.Examine.class.php     |    4 +++-
plugins/spamx/MailAdmin.Action.class.php        |    3 +++
plugins/spamx/MassDelTrackback.Admin.class.php  |    9 +++++++++
plugins/spamx/MassDelete.Admin.class.php        |    9 +++++++++
plugins/spamx/ProjectHoneyPot.Examine.class.php |    3 ++-
plugins/spamx/SLV.Examine.class.php             |    4 ++--
plugins/spamx/SLVbase.class.php                 |    4 ++--
plugins/spamx/SLVreport.Action.class.php        |    3 ++-
plugins/spamx/SLVwhitelist.Admin.class.php      |    9 +++++++--

diffs (truncated from 389 to 300 lines):

diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/BaseAdmin.class.php
--- a/plugins/spamx/BaseAdmin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/BaseAdmin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -6,11 +6,9 @@
  * @author Tom Willett	tomw AT pigstye DOT net 
  *
  * @package Spam-X
+ * @abstract
+ *
  */
-
-/**
-* @abstract
-*/
 class BaseAdmin {
     /**
      * 
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/BaseCommand.class.php
--- a/plugins/spamx/BaseCommand.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/BaseCommand.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -6,11 +6,9 @@
  * @author Tom Willett	tomw AT pigstye DOT net 
  *
  * @package Spam-X
+ * @abstract
+ *
  */
-
-/**
-* @abstract
-*/
 class BaseCommand {
     /**
      * 
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/BlackList.Examine.class.php
--- a/plugins/spamx/BlackList.Examine.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/BlackList.Examine.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -25,8 +25,9 @@
  * Examines Comment according to Personal BLacklist
  * 
  * @author Tom Willett tomw AT pigstye DOT net 
+ * @package Spam-X
+ *
  */
-
 class BlackList extends BaseCommand {
     /**
      * No Constructor Use BaseCommand constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/DeleteComment.Action.class.php
--- a/plugins/spamx/DeleteComment.Action.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/DeleteComment.Action.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -25,6 +25,8 @@
  * Action Class which just discards comment
  * 
  * @author Tom Willett  tomw at pigstye.net 
+ * @package Spam-X
+ *
  */
 class DeleteComment extends BaseCommand {
     /**
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/EditBlackList.Admin.class.php
--- a/plugins/spamx/EditBlackList.Admin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/EditBlackList.Admin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -18,11 +18,16 @@
 }
 
 /**
- * Personal Black List Editor
- */
-
+* Include Abstract Base Class
+*/
 require_once $_CONF['path'] . 'plugins/spamx/BaseAdmin.class.php';
 
+/**
+ * Personal Black List Editor
+ *
+ * @package Spam-X
+ *
+ */
 class EditBlackList extends BaseAdmin {
     /**
      * Constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/EditHeader.Admin.class.php
--- a/plugins/spamx/EditHeader.Admin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/EditHeader.Admin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -19,11 +19,16 @@
 }
 
 /**
-* HTTP Header Editor
+* Include Abstract Base Class
 */
-
 require_once $_CONF['path'] . 'plugins/spamx/BaseAdmin.class.php';
 
+/**
+* HTTP Header Editor
+*
+* @package Spam-X
+*
+*/
 class EditHeader extends BaseAdmin {
     /**
      * Constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/EditIP.Admin.class.php
--- a/plugins/spamx/EditIP.Admin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/EditIP.Admin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -18,11 +18,16 @@
 }
 
 /**
-* IP Black List Editor
+* Include Abstract Base Class
 */
-
 require_once $_CONF['path'] . 'plugins/spamx/BaseAdmin.class.php';
 
+/**
+* IP Black List Editor
+*
+* @package Spam-X
+*
+*/
 class EditIP extends BaseAdmin {
     /**
      * Constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/EditIPofURL.Admin.class.php
--- a/plugins/spamx/EditIPofURL.Admin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/EditIPofURL.Admin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -18,11 +18,16 @@
 }
 
 /**
-* IP of URL Black List Editor
+* Include Abstract Base Class
 */
-
 require_once $_CONF['path'] . 'plugins/spamx/BaseAdmin.class.php';
 
+/**
+* IP of URL Black List Editor
+*
+* @package Spam-X
+*
+*/
 class EditIPofUrl extends BaseAdmin {
     /**
      * Constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/Header.Examine.class.php
--- a/plugins/spamx/Header.Examine.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/Header.Examine.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -27,8 +27,10 @@
 * Examines Post according to HTTP Headers
 *
 * @author Dirk Haun <dirk AT haun-online DOT de>
+*
+* @package Spam-X
+*
 */
-
 class Header extends BaseCommand {
     /**
      * No Constructor Use BaseCommand constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/IP.Examine.class.php
--- a/plugins/spamx/IP.Examine.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/IP.Examine.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -25,8 +25,10 @@
 * Examines Comment according to Personal BLacklist
 *
 * @author Tom Willett tomw AT pigstye DOT net
+*
+* @package Spam-X
+*
 */
-
 class IP extends BaseCommand {
     /**
      * No Constructor Use BaseCommand constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/IPofUrl.Examine.class.php
--- a/plugins/spamx/IPofUrl.Examine.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/IPofUrl.Examine.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -25,8 +25,10 @@
 * Examines Comment according to Personal BLacklist
 *
 * @author Tom Willett tomw AT pigstye DOT net
+*
+* @package Spam-X
+*
 */
-
 class IPofUrl extends BaseCommand {
     /**
      * No Constructor Use BaseCommand constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/Import.Admin.class.php
--- a/plugins/spamx/Import.Admin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/Import.Admin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -22,8 +22,17 @@
     die('This file can not be used on its own!');
 }
 
+/**
+* Include Abstract Base Class
+*/
 require_once $_CONF['path'] . 'plugins/spamx/BaseAdmin.class.php';
 
+/**
+* MTBlacklist Import
+*
+* @package Spam-X
+*
+*/
 class Import extends BaseAdmin {
     /**
      * Constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/LogView.Admin.class.php
--- a/plugins/spamx/LogView.Admin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/LogView.Admin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -16,8 +16,17 @@
     die('This file can not be used on its own!');
 }
 
+/**
+* Include Abstract Base Class
+*/
 require_once $_CONF['path'] . 'plugins/spamx/BaseAdmin.class.php';
 
+/**
+* LogView class
+*
+* @package Spam-X
+*
+*/
 class LogView extends BaseAdmin {
     /**
      * Constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/MTBlackList.Examine.class.php
--- a/plugins/spamx/MTBlackList.Examine.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/MTBlackList.Examine.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -29,8 +29,10 @@
  * Examines Comment according to MT-BLacklist
  * 
  * @author Tom Willett tomw AT pigstye DOT net 
+ *
+ * @package Spam-X
+ *
  */
-
 class MTBlackList extends BaseCommand {
     /**
      * No Constructor Use BaseCommand constructor
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/MailAdmin.Action.class.php
--- a/plugins/spamx/MailAdmin.Action.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/MailAdmin.Action.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -25,6 +25,9 @@
  * Action Class which emails the spam post to the site admin
  * 
  * @author Tom Willett  tomw at pigstye.net 
+ *
+ * @package Spam-X
+ *
  */
 class MailAdmin extends BaseCommand {
     /**
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/MassDelTrackback.Admin.class.php
--- a/plugins/spamx/MassDelTrackback.Admin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/MassDelTrackback.Admin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -19,8 +19,17 @@
     die('This file can not be used on its own!');
 }
 
+/**
+* Include Abstract Base Class
+*/
 require_once $_CONF['path'] . 'plugins/spamx/BaseAdmin.class.php';
 
+/**
+* MassDelTrackback class: Mass-delete trackbacks
+*
+* @package Spam-X
+*
+*/
 class MassDelTrackback extends BaseAdmin {
 
     function display()
diff -r e08e75f92937 -r c9bc3cf73464 plugins/spamx/MassDelete.Admin.class.php
--- a/plugins/spamx/MassDelete.Admin.class.php	Sat Mar 07 15:40:22 2009 +0100
+++ b/plugins/spamx/MassDelete.Admin.class.php	Sat Mar 07 17:16:51 2009 +0100
@@ -17,9 +17,18 @@
     die('This file can not be used on its own!');
 }
 
+/**
+* Include Abstract Base Class and comment library
+*/
 require_once $_CONF['path'] . 'plugins/spamx/BaseAdmin.class.php';
 require_once $_CONF['path_system'] . 'lib-comment.php';
 
+/**
+* MassDelete class: Mass-delete comments



More information about the geeklog-cvs mailing list