From f3a91d6be97471cf0fa274d74940541ac2686a20 Mon Sep 17 00:00:00 2001
From: tokul <tokul@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Mon, 12 Apr 2004 07:18:29 +0000
Subject: [PATCH] phpdoc blocks

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@7087 7612ce4b-ef26-0410-bec9-ea0150e637f0
---
 plugins/spamcop/index.php   | 24 +++++++++++-------------
 plugins/spamcop/options.php | 20 ++++++++++----------
 plugins/spamcop/setup.php   | 28 +++++++++++++++++-----------
 plugins/spamcop/spamcop.php | 20 ++++++++++----------
 4 files changed, 48 insertions(+), 44 deletions(-)

diff --git a/plugins/spamcop/index.php b/plugins/spamcop/index.php
index f01f8baa..275ca632 100644
--- a/plugins/spamcop/index.php
+++ b/plugins/spamcop/index.php
@@ -1,17 +1,15 @@
 <?php
-
-   /**
-    **  index.php -- Displays the main frameset
-    **
-    **  Copyright (c) 1999-2004 The SquirrelMail development team
-    **  Licensed under the GNU GPL. For full terms see the file COPYING.
-    **
-    **  Redirects to the login page.
-    **
-    **  $Id$
-    * @package plugins
-    * @subpackage spamcop
-    **/
+/**
+ *  index.php -- Displays the main frameset
+ *
+ * Redirects to the login page.
+ *
+ * @copyright (c) 1999-2004 The SquirrelMail development team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage spamcop
+ */
 
    header("Location:../../src/login.php\n\n");
    exit();
diff --git a/plugins/spamcop/options.php b/plugins/spamcop/options.php
index 4b3d0922..63de0903 100755
--- a/plugins/spamcop/options.php
+++ b/plugins/spamcop/options.php
@@ -1,15 +1,14 @@
 <?php
 
-   /**
-    **  options.php -- SpamCop options page
-    **
-    **  Copyright (c) 1999-2004 The SquirrelMail development team
-    **  Licensed under the GNU GPL. For full terms see the file COPYING.
-    **
-    **  $Id$
-    * @package plugins
-    * @subpackage spamcop
-    **/
+/**
+ *  options.php -- SpamCop options page
+ *
+ * @copyright (c) 1999-2004 The SquirrelMail development team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage spamcop
+ */
 
 /** @ignore */
 define('SM_PATH','../../');
@@ -19,6 +18,7 @@ require_once(SM_PATH . 'include/validate.php');
  * Internal spamcop plugin function.
  *
  * It is used to display similar action links.
+ * @access private
  */
 function spamcop_enable_disable($option,$disable_action,$enable_action) {
     if ($option) { 
diff --git a/plugins/spamcop/setup.php b/plugins/spamcop/setup.php
index 0613a87b..9437bf80 100755
--- a/plugins/spamcop/setup.php
+++ b/plugins/spamcop/setup.php
@@ -1,14 +1,13 @@
 <?php
-   /** 
-    **  setup.php -- SpamCop plugin           
-    **
-    **  Copyright (c) 1999-2004 The SquirrelMail development team
-    **  Licensed under the GNU GPL. For full terms see the file COPYING.
-    **  
-    **  $Id$
-    * @package plugins
-    * @subpackage spamcop
-    **/
+/** 
+ * setup.php -- SpamCop plugin - setup script
+ *
+ * @copyright (c) 1999-2004 The SquirrelMail development team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage spamcop
+ */
 
 /** @ignore */
 require_once(SM_PATH . 'functions/global.php');
@@ -16,7 +15,10 @@ require_once(SM_PATH . 'functions/global.php');
 /** Disable Quick Reporting by default */
 $spamcop_quick_report = false;
 
-/** Initialize the plugin */
+/**
+ * Initialize the plugin 
+ * @access private
+ */
 function squirrelmail_plugin_init_spamcop() {
    global $squirrelmail_plugin_hooks, $data_dir, $username,
       $spamcop_is_composing;
@@ -39,6 +41,7 @@ function squirrelmail_plugin_init_spamcop() {
 
 /**
  * Loads spamcop settings and validates some of values (make '' into 'default', etc.)
+ * @access private
  */
 function spamcop_load() {
    global $username, $data_dir, $spamcop_enabled, $spamcop_delete,
@@ -69,6 +72,7 @@ function spamcop_load() {
 
 /**
  * Shows spamcop link on the read-a-message screen
+ * @access private
  */
 function spamcop_show_link() {
    global $spamcop_enabled, $spamcop_method, $spamcop_quick_report,$javascript_on;
@@ -116,6 +120,7 @@ document.write("</a>");
 
 /**
  * Show spamcop options block
+ * @access private
  */
 function spamcop_options()
 {
@@ -132,6 +137,7 @@ function spamcop_options()
 
 /**
  * When we send the email, we optionally trash it then too
+ * @access private
  */
 function spamcop_while_sending()
 {
diff --git a/plugins/spamcop/spamcop.php b/plugins/spamcop/spamcop.php
index 7a69bca7..5c97285d 100644
--- a/plugins/spamcop/spamcop.php
+++ b/plugins/spamcop/spamcop.php
@@ -1,14 +1,13 @@
 <?php
-   /** 
-    **  spamcop.php -- SpamCop plugin           
-    **
-    **  Copyright (c) 1999-2004 The SquirrelMail development team
-    **  Licensed under the GNU GPL. For full terms see the file COPYING.
-    **  
-    **  $Id$
-    * @package plugins
-    * @subpackage spamcop
-    **/
+/** 
+ * spamcop.php -- SpamCop plugin -- main page
+ *
+ * @copyright (c) 1999-2004 The SquirrelMail development team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage spamcop
+ */
 
 /** @ignore */
 define('SM_PATH','../../');
@@ -19,6 +18,7 @@ require_once(SM_PATH . 'functions/imap.php');
 
 /**
  * Stores message in attachment directory, when email based reports are used
+ * @access private
  */
 function getMessage_RFC822_Attachment($message, $composeMessage, $passed_id, 
                                       $passed_ent_id='', $imapConnection) {
-- 
2.25.1