PHPdoc fix

e107_handlers/admin_log_class.php

@@ -11,8 +11,8 @@
  |     GNU General Public License (http://gnu.org).
  |
  |     $Source: /cvs_backup/e107_0.8/e107_handlers/admin_log_class.php,v $
- |     $Revision: 1.17 $
+ |     $Revision: 1.18 $
- |     $Date: 2009-11-17 10:30:40 $
+ |     $Date: 2009-11-17 14:50:37 $
  |     $Author: marj_nl_fr $
  To do:
  1. Do we need to check for presence of elements of debug_backtrace() to avoid notices?
@@ -316,7 +316,7 @@ class e_admin_log
 	 * Removes all events older than $days, or truncates the table if $days == false
 	 *
 	 * @param integer|false $days
-	 *@return void
+	 * @return void
 	 */
 	function purge_log_events($days)
 	{

e107_handlers/theme_handler.php

@@ -9,9 +9,9 @@
  * e107 Admin Theme Handler
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/theme_handler.php,v $
- * $Revision: 1.64 $
+ * $Revision: 1.65 $
- * $Date: 2009-11-09 00:27:43 $
+ * $Date: 2009-11-17 14:50:33 $
- * $Author: e107coders $
+ * $Author: marj_nl_fr $
  */
 
 if(!defined('e107_INIT'))
@@ -279,9 +279,10 @@ class themeHandler
 	}
 	
 	/**
-	 * Validate and return the name of the category
+	 * Validate and return the name of the categories.
-	 * @param object $categoryfromXML
+	 *
-	 * @return
+	 * @param string [optional] $categoryfromXML
+	 * @return string
 	 */
 	function getThemeCategory($categoryfromXML = '')
 	{
@@ -1046,8 +1047,9 @@ class themeHandler
 	
 	/**
 	 * Set Theme as Main Theme.
-	 * @param object $name [optional] name (folder) of the theme to set.
+	 *
-	 * @return
+	 * @param string $name [optional] name (folder) of the theme to set.
+	 * @return boolean TRUE on success, FALSE otherwise
 	 */
 	function setTheme($name = '')
 	{

e107_handlers/user_handler.php

@@ -9,9 +9,9 @@
  * Handler - user-related functions
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/user_handler.php,v $
- * $Revision: 1.16 $
+ * $Revision: 1.17 $
- * $Date: 2009-11-12 05:11:42 $
+ * $Date: 2009-11-17 14:50:32 $
- * $Author: e107coders $
+ * $Author: marj_nl_fr $
  *
 */
 
@@ -834,13 +834,14 @@ class e_userperms
 	
 	/**
 	 * Render edit admin perms form. 
+	 *
 	 * @param array $row [optional] containing $row['user_id'], $row['user_name'], $row['user_perms'];
-	 * @return 
+	 * @return void
 	 */
-	function edit_administrator($row='')
+	function edit_administrator($row = '')
 	{
-	    global $pref;
+		$pref = e107::getPref();
-		$lanlist = explode(",",e_LANLIST);
+		$lanlist = explode(",", e_LANLIST);
 		require_once(e_HANDLER."user_handler.php");
 		$prm = $this;
 		$ns = e107::getRender();
@@ -908,12 +909,14 @@ class e_userperms
 	}
 	
 	/**
-	 * Update user (admin) perms
+	 * Update user (admin) permissions.
-	 * @param int $uid
+	 * NOTE: exit if $uid is not an integer or is 0.
-	 * @param array $permArray eg. array('A','K','1');
+	 *
-	 * @return 
+	 * @param integer $uid
+	 * @param array $permArray eg. array('A', 'K', '1');
+	 * @return void 
 	 */
-	function updatePerms($uid,$permArray)
+	function updatePerms($uid, $permArray)
 	{
 		global $admin_log;
 		
@@ -923,7 +926,7 @@ class e_userperms
 		$modID = intval($uid);
 		if ($modID == 0)
 		{
-			exit;
+			exit();
 		}
 		
 		$sql->db_Select("user", "*", "user_id=".$modID);
@@ -945,12 +948,11 @@ class e_userperms
 			{
 				$perm .= $value.".";
 			}
-	    }
+	  }
 	
 		admin_update($sql->db_Update("user", "user_perms='{$perm}' WHERE user_id='{$modID}' "), 'update', sprintf(ADMSLAN_2, $tp->toDB($_POST['ad_name'])), false, false);
 		$logMsg = str_replace(array('--ID--', '--NAME--'),array($modID, $a_name),ADMSLAN_72).$perm;
 		$admin_log->log_event('ADMIN_01',$logMsg,E_LOG_INFORMATIVE,'');
 	}
-}
 
-?>
+}

e107_handlers/validator_class.php

@@ -9,9 +9,9 @@
  * Handler - general purpose validation functions
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/validator_class.php,v $
- * $Revision: 1.14 $
+ * $Revision: 1.15 $
- * $Date: 2009-11-07 02:16:52 $
+ * $Date: 2009-11-17 14:50:26 $
- * $Author: e107coders $
+ * $Author: marj_nl_fr $
  *
 */
 
@@ -245,9 +245,10 @@ class e_validator
 	
 	/**
 	 * Add successfully validated data to the valid array 
+	 *
 	 * @param string $field_name
 	 * @param mixed $value
-	 * @return 
+	 * @return e_validator
 	 */
 	protected function addValidData($field_name, $value)
 	{

e107_handlers/xml_class.php

@@ -9,8 +9,8 @@
  * Simple XML Parser
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/xml_class.php,v $
- * $Revision: 1.35 $
+ * $Revision: 1.36 $
- * $Date: 2009-11-17 10:30:39 $
+ * $Date: 2009-11-17 14:50:30 $
  * $Author: marj_nl_fr $
 */
 
@@ -383,12 +383,12 @@ class xmlClass
 	
 	/**
 	 * Advanced XML parser - handles tags with attributes and values
-	 * proper. 
+	 * properly.
 	 * TODO - filter (see xml_convert_to_array)
 	 * 
 	 * @param SimpleXMLElement $xml
 	 * @param string $rec_parent used for recursive calls only
-	 * @return 
+	 * @return array
 	 */
 	function xml2array($xml, $rec_parent = '')
 	{
@@ -555,7 +555,7 @@ class xmlClass
 	 * Convert Array(0) to String based on specified Tags. 
 	 *
 	 * @param array|string $vars
-	 * @return 
+	 * @return string
 	 */
 	function parseStringTags($vars)
 	{