phpdoc updates

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

diff --git a/plugins/administrator/auth.php b/plugins/administrator/auth.php
index afbd8719e61ede224da6ad5c4d1dc7f7ec2d4890..c32ccbe738715614e14dd065559ede84851406e5 100644 (file)
--- a/plugins/administrator/auth.php
+++ b/plugins/administrator/auth.php
@@ -1,19 +1,24 @@
 <?php
-
 /**
- *  This function tell other modules what users have access
- *  to the plugin.
- *  
- *  Philippe Mingo
- *  
- *  $Id$
+ * Administrator plugin - Authentication routines
+ *
+ * This function tell other modules what users have access
+ * to the plugin.
+ *
+ * @version $Id$
+ * @author Philippe Mingo
+ * @copyright (c) 1999-2004 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @package plugins
  * @subpackage administrator
  */
 
 /**
-*
-*/
+ * Check if user has access to administrative functions
+ *
+ * @return boolean
+ * @access private
+ */
 function adm_check_user() {
     global $PHP_SELF;
     require_once(SM_PATH . 'functions/global.php');
@@ -41,4 +46,4 @@ function adm_check_user() {
     return ($auth);
 }
 
-?>
+?>
\ No newline at end of file