[geeklog-cvs] geeklog: An attempt to get phpDocumentator to recognize Spam-X a...

geeklog-cvs at lists.geeklog.net geeklog-cvs at lists.geeklog.net
Sat Mar 7 09:42:06 EST 2009


details:   http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/c6b33dac067e
changeset: 6818:c6b33dac067e
user:      Dirk Haun <dirk at haun-online.de>
date:      Sat Mar 07 15:11:33 2009 +0100
description:
An attempt to get phpDocumentator to recognize Spam-X as a package and produce some documentation

diffstat:

25 files changed, 83 insertions(+), 38 deletions(-)
plugins/spamx/BaseAdmin.class.php               |    5 ++-
plugins/spamx/BaseCommand.class.php             |    9 ++++--
plugins/spamx/BlackList.Examine.class.php       |    2 -
plugins/spamx/DeleteComment.Action.class.php    |    2 -
plugins/spamx/EditBlackList.Admin.class.php     |    1 
plugins/spamx/EditHeader.Admin.class.php        |    1 
plugins/spamx/EditIP.Admin.class.php            |    1 
plugins/spamx/EditIPofURL.Admin.class.php       |    1 
plugins/spamx/Header.Examine.class.php          |    2 -
plugins/spamx/IP.Examine.class.php              |    2 -
plugins/spamx/IPofUrl.Examine.class.php         |    2 -
plugins/spamx/Import.Admin.class.php            |    1 
plugins/spamx/LogView.Admin.class.php           |    2 -
plugins/spamx/MTBlackList.Examine.class.php     |    1 
plugins/spamx/MailAdmin.Action.class.php        |    2 -
plugins/spamx/MassDelTrackback.Admin.class.php  |    2 -
plugins/spamx/MassDelete.Admin.class.php        |    2 -
plugins/spamx/ProjectHoneyPot.Examine.class.php |    6 ++--
plugins/spamx/SLV.Examine.class.php             |    2 -
plugins/spamx/SLVbase.class.php                 |    2 -
plugins/spamx/SLVreport.Action.class.php        |    2 -
plugins/spamx/SLVwhitelist.Admin.class.php      |    1 
plugins/spamx/autoinstall.php                   |   33 ++++++++++++++++++-----
plugins/spamx/functions.inc                     |   24 +++++++++-------
plugins/spamx/install_defaults.php              |   13 +++++----

diffs (truncated from 467 to 300 lines):

diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/BaseAdmin.class.php
--- a/plugins/spamx/BaseAdmin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/BaseAdmin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -5,9 +5,12 @@
  * 
  * @author Tom Willett	tomw AT pigstye DOT net 
  *
- * $Id: BaseAdmin.class.php,v 1.3 2005/04/10 10:02:42 dhaun Exp $
+ * @package Spam-X
  */
 
+/**
+* @abstract
+*/
 class BaseAdmin {
     /**
      * 
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/BaseCommand.class.php
--- a/plugins/spamx/BaseCommand.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/BaseCommand.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -5,17 +5,21 @@
  * 
  * @author Tom Willett	tomw AT pigstye DOT net 
  *
- * $Id: BaseCommand.class.php,v 1.3 2005/04/10 10:02:43 dhaun Exp $
+ * @package Spam-X
  */
 
+/**
+* @abstract
+*/
 class BaseCommand {
     /**
      * 
      * @access public 
      */
 
-    var $result = null; //Result of execute command
+    var $result = null; // Result of execute command
     var $num = 0; // Action Number	
+
     /**
      * Constructor
      * 
@@ -36,6 +40,7 @@
 
         return $result;
     } 
+
     function number()
     {
         global $num;
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/BlackList.Examine.class.php
--- a/plugins/spamx/BlackList.Examine.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/BlackList.Examine.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
  * 
  * Licensed under GNU General Public License
  *
- * $Id: BlackList.Examine.class.php,v 1.13 2008/09/21 08:37:08 dhaun Exp $
+ * @package Spam-X
  */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'BlackList.Examine.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/DeleteComment.Action.class.php
--- a/plugins/spamx/DeleteComment.Action.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/DeleteComment.Action.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
  * 
  * Licensed under GNU General Public License
  *
- * $Id: DeleteComment.Action.class.php,v 1.7 2008/09/21 08:37:08 dhaun Exp $
+ * @package Spam-X
  */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'DeleteComment.Action.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/EditBlackList.Admin.class.php
--- a/plugins/spamx/EditBlackList.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/EditBlackList.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -10,6 +10,7 @@
  *
  * Licensed under GNU General Public License
  *
+ * @package Spam-X
  */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'EditBlackList.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/EditHeader.Admin.class.php
--- a/plugins/spamx/EditHeader.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/EditHeader.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -11,6 +11,7 @@
 *
 * Licensed under GNU General Public License
 *
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'EditHeader.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/EditIP.Admin.class.php
--- a/plugins/spamx/EditIP.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/EditIP.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -10,6 +10,7 @@
 *
 * Licensed under GNU General Public License
 *
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'EditIP.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/EditIPofURL.Admin.class.php
--- a/plugins/spamx/EditIPofURL.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/EditIPofURL.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -10,6 +10,7 @@
 *
 * Licensed under GNU General Public License
 *
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'EditIPofURL.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/Header.Examine.class.php
--- a/plugins/spamx/Header.Examine.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/Header.Examine.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -11,7 +11,7 @@
 *
 * Licensed under the GNU General Public License
 *
-* $Id: Header.Examine.class.php,v 1.6 2008/09/21 08:37:08 dhaun Exp $
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'Header.Examine.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/IP.Examine.class.php
--- a/plugins/spamx/IP.Examine.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/IP.Examine.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
 *
 * Licensed under GNU General Public License
 *
-* $Id: IP.Examine.class.php,v 1.12 2008/09/21 08:37:08 dhaun Exp $
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'IP.Examine.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/IPofUrl.Examine.class.php
--- a/plugins/spamx/IPofUrl.Examine.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/IPofUrl.Examine.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
 *
 * Licensed under GNU General Public License
 *
-* $Id: IPofUrl.Examine.class.php,v 1.6 2008/09/21 08:37:08 dhaun Exp $
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'IPofUrl.Examine.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/Import.Admin.class.php
--- a/plugins/spamx/Import.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/Import.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -15,6 +15,7 @@
  * Based on MT-Blacklist Updater by
  * Cheah Chu Yeow (http://blog.codefront.net/)
  *
+ * @package Spam-X
  */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'Import.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/LogView.Admin.class.php
--- a/plugins/spamx/LogView.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/LogView.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
  *
  * Licensed under GNU General Public License
  *
- * $Id: LogView.Admin.class.php,v 1.11 2008/09/21 08:37:08 dhaun Exp $
+ * @package Spam-X
  */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'LogView.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/MTBlackList.Examine.class.php
--- a/plugins/spamx/MTBlackList.Examine.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/MTBlackList.Examine.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -13,6 +13,7 @@
  * The MT-Blacklist was maintained by Jay Allen
  * http://www.jayallen.org/comment_spam/
  *
+ * @package Spam-X
  */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'MTBlackList.Examine.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/MailAdmin.Action.class.php
--- a/plugins/spamx/MailAdmin.Action.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/MailAdmin.Action.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
  * 
  * Licensed under GNU General Public License
  *
- * $Id: MailAdmin.Action.class.php,v 1.15 2008/09/21 08:37:08 dhaun Exp $
+ * @package Spam-X
  */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'MailAdmin.Action.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/MassDelTrackback.Admin.class.php
--- a/plugins/spamx/MassDelTrackback.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/MassDelTrackback.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -12,7 +12,7 @@
 *
 * Licensed under GNU General Public License
 *
-* $Id: MassDelTrackback.Admin.class.php,v 1.11 2008/09/21 08:37:08 dhaun Exp $
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'MassDelTrackback.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/MassDelete.Admin.class.php
--- a/plugins/spamx/MassDelete.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/MassDelete.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -10,7 +10,7 @@
 *
 * Licensed under GNU General Public License
 *
-* $Id: MassDelete.Admin.class.php,v 1.22 2008/09/21 08:37:08 dhaun Exp $
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'MassDelete.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/ProjectHoneyPot.Examine.class.php
--- a/plugins/spamx/ProjectHoneyPot.Examine.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/ProjectHoneyPot.Examine.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -33,8 +33,10 @@
 // | Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.           |
 // |                                                                           |
 // +---------------------------------------------------------------------------+
-//
-// $Id: ProjectHoneyPot.Examine.class.php,v 1.4 2008/09/21 08:37:08 dhaun Exp $
+
+/**
+* @package Spam-X
+*/
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'ProjectHoneyPot.Examine.class.php') !== false) {
     die('This file can not be used on its own!');
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/SLV.Examine.class.php
--- a/plugins/spamx/SLV.Examine.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/SLV.Examine.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
 *
 * Licensed under the GNU General Public License
 *
-* $Id: SLV.Examine.class.php,v 1.2 2008/09/21 08:37:08 dhaun Exp $
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'SLV.Examine.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/SLVbase.class.php
--- a/plugins/spamx/SLVbase.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/SLVbase.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
 *
 * Licensed under the GNU General Public License
 *
-* $Id: SLVbase.class.php,v 1.7 2008/09/21 08:37:08 dhaun Exp $
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'SLVbase.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/SLVreport.Action.class.php
--- a/plugins/spamx/SLVreport.Action.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/SLVreport.Action.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -9,7 +9,7 @@
 *
 * Licensed under the GNU General Public License
 *
-* $Id: SLVreport.Action.class.php,v 1.2 2008/09/21 08:37:08 dhaun Exp $
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'SLVreport.Action.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/SLVwhitelist.Admin.class.php
--- a/plugins/spamx/SLVwhitelist.Admin.class.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/SLVwhitelist.Admin.class.php	Sat Mar 07 15:11:33 2009 +0100
@@ -10,6 +10,7 @@
 *
 * Licensed under GNU General Public License
 *
+* @package Spam-X
 */
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'SLVwhitelist.Admin.class.php') !== false) {
diff -r 3b4d3b5170dc -r c6b33dac067e plugins/spamx/autoinstall.php
--- a/plugins/spamx/autoinstall.php	Wed Mar 04 14:15:22 2009 +0100
+++ b/plugins/spamx/autoinstall.php	Sat Mar 07 15:11:33 2009 +0100
@@ -8,7 +8,7 @@
 // |                                                                           |
 // | This file provides helper functions for the automatic plugin install.     |
 // +---------------------------------------------------------------------------+
-// | Copyright (C) 2008 by the following authors:                              |
+// | Copyright (C) 2008-2009 by the following authors:                         |
 // |                                                                           |
 // | Authors: Dirk Haun         - dirk AT haun-online DOT de                   |



More information about the geeklog-cvs mailing list