Minor code cleanup
[squirrelmail.git] / plugins / info / setup.php
index 6adcf0745e87e62db1763c7fcecd5a46655f9d57..2ede4054ce19f29380ee181c329d4814f42f705a 100644 (file)
@@ -1,29 +1,38 @@
 <?php
-
-/* setup file for the IMAP server info plugin
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *   
- * by: Jason Munro jason@stdbev.com
- * 
- * $Id$
+/**
+ * setup file for the IMAP server info plugin
  * 
+ * @copyright (c) 1999-2004 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @author Jason Munro jason@stdbev.com
+ * @package plugins
+ * @subpackage info
  */
 
+/** @ignore */
 require_once (SM_PATH . 'plugins/info/functions.php');
 
+/**
+ * Plugin init function
+ * @access private
+ */
 function squirrelmail_plugin_init_info() {
     global $squirrelmail_plugin_hooks;
     $squirrelmail_plugin_hooks['optpage_register_block']['info'] = 'info_opt';
 }
 
+/**
+ * Plugin's block in option page
+ * @access private
+ */
 function info_opt() {
     global $optpage_blocks;
 
     $optpage_blocks[] = array(
         'name' => _("IMAP server information"),
         'url'  => '../plugins/info/options.php',
-        'desc' => _("Run some test IMAP commands, displaying both the command and the result. These tests use the Squirrelmail IMAP commands and your current Squirrelmail configuration. Custom command strings can be used."),
+        'desc' => _("Run some test IMAP commands, displaying both the command and the result. These tests use the SquirrelMail IMAP commands and your current SquirrelMail configuration. Custom command strings can be used."),
         'js'   => false
     );
 }