Revise plugin documentation. Mainly, this removes remains of documentation

[squirrelmail.git] / plugins / administrator / setup.php

diff --git a/plugins/administrator/setup.php b/plugins/administrator/setup.php
index 98a99b96a3a76e80c13a8147b139a7c14a9890a6..94af22ac6706459ff1238199ffbc2561e0fee0ea 100644 (file)
--- a/plugins/administrator/setup.php
+++ b/plugins/administrator/setup.php
@@ -1,36 +1,45 @@
 <?php
-
 /**
- * setup.php
- *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * Administrator plugin - Setup script
  *
- *  Administrator plugin. Allows remote administration.  Philippe Mingo
+ * Plugin allows remote administration.
  *
- * $Id$
+ * @version $Id$
+ * @author Philippe Mingo
+ * @copyright (c) 1999-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @package plugins
+ * @subpackage administrator
  */
 
+/** @ignore */
 require_once(SM_PATH . 'plugins/administrator/auth.php');
 
+/**
+ * Init the plugin
+ * @access private
+ */
 function squirrelmail_plugin_init_administrator() {
-    global $squirrelmail_plugin_hooks, $username;
+    global $squirrelmail_plugin_hooks;
 
-    if ( adm_check_user() ) {        
+    if ( adm_check_user() ) {
         $squirrelmail_plugin_hooks['optpage_register_block']['administrator'] =
                                   'squirrelmail_administrator_optpage_register_block';
     }
 }
 
+/**
+ * Register option block
+ * @access private
+ */
 function squirrelmail_administrator_optpage_register_block() {
     global $optpage_blocks;
-    global $AllowSpamFilters;
 
     $optpage_blocks[] = array(
         'name' => _("Administration"),
-        'url'  => '../plugins/administrator/options.php',
+        'url'  => SM_PATH . 'plugins/administrator/options.php',
         'desc' => _("This module allows administrators to manage SquirrelMail main configuration remotely."),
         'js'   => false
     );
 }
-?>
+?>
\ No newline at end of file