Fix documentation errors

class2.php

@@ -9,9 +9,9 @@
 * General purpose file
 *
 * $Source: /cvs_backup/e107_0.8/class2.php,v $
-* $Revision: 1.167 $
+* $Revision: 1.168 $
-* $Date: 2009-12-12 11:01:03 $
+* $Date: 2009-12-13 21:52:29 $
-* $Author: e107coders $
+* $Author: e107steved $
 *
 */
 //
@@ -37,6 +37,11 @@
 // P: Load theme
 // Q: Other setups
 
+/**
+ * @package e107
+ */
+
+
 //
 // A: Honest global beginning point for processing time
 //
@@ -694,7 +699,13 @@ if($pref['sitelanguage'] != e_LANGUAGE && varset($pref['multilanguage']) && !$pr
 }
 else
 {
+	/**
+	 * @ignore
+	 */
 	define('e_LAN', false);
+	/**
+	 * @ignore
+	 */
 	define('e_LANQRY', false);
 }
 $sql->db_Mark_Time('(Start: Pref/multilang done)');
@@ -844,6 +855,9 @@ $sql->db_Mark_Time('Start: Misc Setup');
 //------------------------------------------------------------------------------------------------------------------------------------//
 if (!class_exists('e107table', false))
 {
+	/**
+	 *	@package e107
+	 */
 	class e107table
 	{
 
@@ -1090,6 +1104,9 @@ if(!defined("THEME_LAYOUT"))
 	else // default layout.
 	{
     	$deflayout = (!isset($user_pref['sitetheme_deflayout'])) ? varset($pref['sitetheme_deflayout']) : $user_pref['sitetheme_deflayout'];
+		/**
+		 * @ignore
+		 */
 		define("THEME_LAYOUT",$deflayout);  // default layout.
 	}
 
@@ -1156,7 +1173,10 @@ if ($pref['antiflood1'] == 1)
 }
 else
 {
-  define('FLOODPROTECT', FALSE);
+	/**
+	 * @ignore
+	 */
+	define('FLOODPROTECT', FALSE);
 }
 
 $layout = isset($layout) ? $layout : '_default';
@@ -1185,6 +1205,9 @@ if(isset($_SERVER['HTTP_REFERER']))
 }
 else
 {
+	/**
+	 * @ignore
+	 */
 	define('e_REFERER_SELF', FALSE);
 }
 
@@ -1508,6 +1531,10 @@ function getcachedvars($id)
 }
 
 //------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------//
+
+/**
+ * @package e107
+ */
 class floodprotect
 {
 	function flood($table, $orderfield)
@@ -1933,6 +1960,9 @@ function force_userupdate($currentUser)
 
 
 
+/**
+ * @package e107
+ */
 class error_handler
 {
 

e107_admin/db.php

@@ -9,9 +9,9 @@
  * Administration - Database Utilities
  *
  * $Source: /cvs_backup/e107_0.8/e107_admin/db.php,v $
- * $Revision: 1.47 $
+ * $Revision: 1.48 $
- * $Date: 2009-11-18 01:04:25 $
+ * $Date: 2009-12-13 21:52:30 $
- * $Author: e107coders $
+ * $Author: e107steved $
  *
 */
 
@@ -363,7 +363,7 @@ class system_tools
 
 	/**
 	 * Delete selected preferences. 
-	 * @return 
+	 * @return none
 	 */	
 	private function del_pref_val($mode='core')
 	{
@@ -423,7 +423,7 @@ class system_tools
 
 	/**
 	 * Render Options
-	 * @return 
+	 * @return none
 	 */	
 	private function render_options()
 	{
@@ -469,7 +469,7 @@ class system_tools
 
 	/**
 	 * Import XML Form
-	 * @return 
+	 * @return none
 	 */	
 	private function importForm()
 	{
@@ -518,7 +518,7 @@ class system_tools
 
 	/**
 	 * Export XML Dump
-	 * @return 
+	 * @return  none
 	 */	
 	private function exportXmlForm()
 	{
@@ -638,7 +638,7 @@ class system_tools
 
 	/**
 	 * Import XML Dump
-	 * @return 
+	 * @return none
 	 */
 	private function importXmlFile()
 	{
@@ -657,7 +657,7 @@ class system_tools
 	
 	/**
 	 * Optimize SQL
-	 * @return 
+	 * @return none
 	 */
 	private function optimizesql($mySQLdefaultdb)
 	{
@@ -674,7 +674,7 @@ class system_tools
 	
 	/**
 	 * Preferences Editor
-	 * @return 
+	 * @return string text for display
 	 */
 	private function pref_editor($type='core')
 	{
@@ -761,7 +761,7 @@ class system_tools
 	
 	/**
 	 * Preferences Editor
-	 * @return 
+	 * @return none
 	 */	
 	private function scan_override()
 	{
@@ -790,7 +790,7 @@ class system_tools
 
 	/**
 	 * Plugin Folder Scanner
-	 * @return 
+	 * @return none
 	 */		
 	private function plugin_viewscan()
 	{
@@ -931,7 +931,7 @@ function db_adminmenu()
  * @param object $prefs
  * @param object $tables
  * @param object $debug [optional]
- * @return 
+ * @return none
  */
 function exportXmlFile($prefs,$tables,$package=FALSE,$debug=FALSE)
 {

e107_admin/image.php

@@ -9,9 +9,9 @@
  * Image Administration Area
  *
  * $Source: /cvs_backup/e107_0.8/e107_admin/image.php,v $
- * $Revision: 1.41 $
+ * $Revision: 1.42 $
- * $Date: 2009-12-04 11:42:04 $
+ * $Date: 2009-12-13 21:52:30 $
- * $Author: e107coders $
+ * $Author: e107steved $
  *
 */
 require_once("../class2.php");
@@ -122,7 +122,7 @@ class faq_cat_ui extends e_admin_ui
 	 *
 	 * @param integer $id [optional] get category title, false - return whole array
 	 * @param mixed $default [optional] default value if not found (default 'n/a')
-	 * @return 
+	 * @return TBD
 	 */
 	function getFaqCategoryTree($id = false, $default = 'n/a')
 	{
@@ -340,7 +340,7 @@ class media_admin_ui extends e_admin_ui
 	
 	/**
 	 * Same as beforeCreate() but invoked on edit  
-	 * @return 
+	 * @return TBD
 	 */
 	public function beforeUpdate($new_data, $old_data, $id)
 	{

e107_admin/language.php

@@ -9,9 +9,9 @@
  * Administration Area - Languages
  *
  * $Source: /cvs_backup/e107_0.8/e107_admin/language.php,v $
- * $Revision: 1.27 $
+ * $Revision: 1.28 $
- * $Date: 2009-11-18 01:04:26 $
+ * $Date: 2009-12-13 21:52:31 $
- * $Author: e107coders $
+ * $Author: e107steved $
  *
  */
 require_once ("../class2.php");
@@ -858,7 +858,7 @@ function grab_lans($path, $language, $filter = "")
  * Compare Language File against script and find unused LANs
  * @param object $lanfile
  * @param object $script
- * @return 
+ * @return string|boolean FALSE on error
  */
 function unused($lanfile,$script)
 {

e107_admin/links.php

@@ -11,9 +11,9 @@
 |     GNU General Public License (http://gnu.org).
 |
 |     $Source: /cvs_backup/e107_0.8/e107_admin/links.php,v $
-|     $Revision: 1.38 $
+|     $Revision: 1.39 $
-|     $Date: 2009-12-02 22:34:15 $
+|     $Date: 2009-12-13 21:52:31 $
-|     $Author: bugrain $
+|     $Author: e107steved $
 +----------------------------------------------------------------------------+
 */
 require_once("../class2.php");
@@ -163,7 +163,7 @@ class links_admin_ui extends e_admin_ui
 
 	/**
 	 * Get linklist in it's proper order.
-	 * @return
+	 * @return none
 	 */
 	function getLinks()
 	{

e107_handlers/admin_ui.php

@@ -69,7 +69,7 @@ class e_admin_request
 	 * Constructor
 	 * 
 	 * @param string|array $qry [optional]
-	 * @return 
+	 * @return none
 	 */
 	public function __construct($request_string = null, $parse = true)
 	{
@@ -279,7 +279,7 @@ class e_admin_request
 	
 	/**
 	 * Get current action
-	 * @return 
+	 * @return TBD
 	 */
 	public function getAction()
 	{
@@ -1262,7 +1262,7 @@ class e_admin_dispatcher
 	
 	/**
 	 *  Default controller name - needed if controller not found
-	 * @return 
+	 * @return string name of controller
 	 */
 	public function getDefaultControllerName()
 	{
@@ -1819,7 +1819,7 @@ class e_admin_controller
 	 * @param string $action [optional]
 	 * @param string|array $exclude_query [optional]
 	 * @param string|array $merge_query [optional]
-	 * @return 
+	 * @return none
 	 */
 	public function redirectAction($action = null, $exclude_query = '', $merge_query = array())
 	{
@@ -1855,7 +1855,7 @@ class e_admin_controller
 	 * @param string $action_name formatted (e.g. request method getActionName()) action name  
 	 * @param string $type page|observer|header|trigger
 	 * @param boolean $ajax force with true/false, if null will be auto-resolved
-	 * @return 
+	 * @return string
 	 */
 	public function toMethodName($action_name, $type= 'page', $ajax = null)
 	{
@@ -2342,7 +2342,7 @@ class e_admin_controller_ui extends e_admin_controller
 	/**
 	 * Manage column visibility
 	 * @param string $batch_trigger
-	 * @return 
+	 * @return none
 	 */
 	public function manageColumns()
 	{
@@ -2861,7 +2861,7 @@ class e_admin_controller_ui extends e_admin_controller
 	 * @param string $callbackBefore existing method from $this scope to be called before submit
 	 * @param string $callbackAfter existing method from $this scope to be called after successfull submit
 	 * @param string $noredirectAction passed to doAfterSubmit()
-	 * @return 
+	 * @return boolean
 	 */
 	protected function _manageSubmit($callbackBefore = '', $callbackAfter = '', $callbackError = '', $noredirectAction = '')
 	{
@@ -2971,7 +2971,7 @@ class e_admin_ui extends e_admin_controller_ui
 	/**
 	 * Catch fieldpref submit
 	 * @param string $batch_trigger
-	 * @return 
+	 * @return none
 	 */
 	public function ListEcolumnsTrigger()
 	{
@@ -2982,7 +2982,7 @@ class e_admin_ui extends e_admin_controller_ui
 	/**
 	 * Catch batch submit
 	 * @param string $batch_trigger
-	 * @return 
+	 * @return none
 	 */
 	public function ListBatchTrigger($batch_trigger)
 	{
@@ -3080,7 +3080,7 @@ class e_admin_ui extends e_admin_controller_ui
 	/**
 	 * Catch delete submit
 	 * @param string $batch_trigger
-	 * @return 
+	 * @return none
 	 */
 	public function ListDeleteTrigger($posted)
 	{
@@ -3205,7 +3205,7 @@ class e_admin_ui extends e_admin_controller_ui
 	
 	/**
 	 * Edit - send JS to page Header
-	 * @return 
+	 * @return none
 	 */
 	function EditHeader()
 	{
@@ -3291,7 +3291,7 @@ class e_admin_ui extends e_admin_controller_ui
 		
 	/**
 	 * Create - send JS to page Header
-	 * @return 
+	 * @return none
 	 */
 	function CreateHeader()
 	{
@@ -3301,7 +3301,7 @@ class e_admin_ui extends e_admin_controller_ui
 	
 	/**
 	 * 
-	 * @return 
+	 * @return TBD
 	 */
 	public function CreatePage()
 	{
@@ -3383,7 +3383,7 @@ class e_admin_ui extends e_admin_controller_ui
 	 * Set read and write parms with drop-down-list array data (ie. type='dropdown')
 	 * @param str $field
 	 * @param array $array [optional]
-	 * @return 
+	 * @return none
 	 */
 	public function setDropDown($field,$array) //TODO Have Miro check this. 
 	{

e107_handlers/bounce_handler.php

@@ -140,7 +140,7 @@ class e107Bounce
 	/**
 	 * Read the Mail. 
 	 * @param object $iKlimit [optional]
-	 * @return 
+	 * @return string mail message
 	 */
 	function mailRead($iKlimit = 4096)
     {

e107_handlers/cache_handler.php

@@ -9,9 +9,9 @@
  * Cache handler
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/cache_handler.php,v $
- * $Revision: 1.17 $
+ * $Revision: 1.18 $
- * $Date: 2009-11-24 16:30:06 $
+ * $Date: 2009-12-13 21:52:31 $
- * $Author: secretr $
+ * $Author: e107steved $
 */
 
 if (!defined('e107_INIT')) { exit; }
@@ -24,8 +24,8 @@ define('CACHE_PREFIX','<?php exit;');
  * 
  * @package     e107
  * @category	e107_handlers
- * @version     $Revision: 1.17 $
+ * @version     $Revision: 1.18 $
- * @author      $Author: secretr $
+ * @author      $Author: e107steved $
  */
 class ecache {
 
@@ -162,7 +162,7 @@ class ecache {
 	 * @param boolean $ForceCache [optional] if TRUE, writes cache even when disabled
 	 * @param boolean $bRaw [optional] if TRUE, writes data exactly as provided instead of prefacing with php leadin
 	 * @param boolean $syscache [optional]
-	 * @return 
+	 * @return none
 	 */
 	public function set($CacheTag, $Data, $ForceCache = false, $bRaw=0, $syscache = false) 
 	{

e107_handlers/core_functions.php

@@ -9,9 +9,9 @@
  * e107 Core functions
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/core_functions.php,v $
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
- * $Date: 2009-11-18 01:04:43 $
+ * $Date: 2009-12-13 21:52:31 $
- * $Author: e107coders $
+ * $Author: e107steved $
 */
 
 //
@@ -46,7 +46,7 @@ function varset(&$val, $default='')
  * 
  * @param string $str
  * @param mixed $default [optional]
- * @return 
+ * @return mixed 
  */
 function defset($str, $default='')
 {

e107_handlers/date_handler.php

@@ -7,8 +7,8 @@
  * GNU General Public License (http://gnu.org).
  * 
  * $Source: /cvs_backup/e107_0.8/e107_handlers/date_handler.php,v $
- * $Revision: 1.14 $
+ * $Revision: 1.15 $
- * $Date: 2009-12-01 20:05:53 $
+ * $Date: 2009-12-13 21:52:31 $
  * $Author: e107steved $
  * 
 */
@@ -70,7 +70,7 @@ class convert
 	 * 
 	 * @param object $date_string
 	 * @param object $mask [optional]
-	 * @return 
+	 * @return integer
 	 */
 	function toTime($date_string, $mask = 'input')
 	{

e107_handlers/e107_class.php

@@ -9,8 +9,8 @@
  * e107 Main
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/e107_class.php,v $
- * $Revision: 1.94 $
+ * $Revision: 1.95 $
- * $Date: 2009-12-13 19:51:36 $
+ * $Date: 2009-12-13 21:52:31 $
  * $Author: e107steved $
 */
 
@@ -654,10 +654,10 @@ class e107
 	 * Multiple plugin preference DB rows are supported
 	 * Class overload is supported.
 	 * Examples:
-	 * - <code>e107::getPluginConfig('myplug');<code>
+	 * - <code>e107::getPluginConfig('myplug');</code>
 	 * 	 will search for e107_plugins/myplug/e_pref/myplug_pref.php which
 	 * 	 should contain class 'e_plugin_myplug_pref' class (child of e_plugin_pref)
-	 * - <code>e107::getPluginConfig('myplug', 'row2');<code>
+	 * - <code>e107::getPluginConfig('myplug', 'row2');</code>
 	 * 	 will search for e107_plugins/myplug/e_pref/myplug_row2_pref.php which
 	 * 	 should contain class 'e_plugin_myplug_row2_pref' class (child of e_plugin_pref)
 	 *
@@ -1044,7 +1044,7 @@ class e107
 	 * Retrieves config() from addons such as e_url.php, e_cron.php, e_sitelink.php
 	 * @param string $addonName eg. e_cron, e_url
 	 * @param string $className [optional] (if different from addonName)
-	 * @return
+	 * @return none
 	 */
 	public function getAddonConfig($addonName, $className = '')
 	{
@@ -1084,7 +1084,7 @@ class e107
 	 * Safe way to call user methods.
 	 * @param string $class_name
 	 * @param string $method_name
-	 * @return
+	 * @return boolean FALSE
 	 */
 	public function callMethod($class_name, $method_name)
 	{
@@ -1214,7 +1214,7 @@ class e107
 	 *
 	 * @param string $id - file prefix, e.g. user for user_template.php
 	 * @param string|null $key
-	 * @param boolean $override see {@link getThemeInfo())
+	 * @param boolean $override see {@link getThemeInfo()}
 	 * @param boolean $merge merge theme with core templates, default is false
 	 * @param boolean $info retrieve template info only
 	 * @return string|array
@@ -1260,7 +1260,7 @@ class e107
 	 * @param string $plug_name
 	 * @param string $id - file prefix, e.g. calendar for calendar_template.php
 	 * @param string|null $key
-	 * @param boolean $override see {@link getThemeInfo())
+	 * @param boolean $override see {@link getThemeInfo()}
 	 * @param boolean $merge merge theme with plugin templates, default is false
 	 * @param boolean $info retrieve template info only
 	 * @return string|array
@@ -1900,7 +1900,7 @@ class e107
 
 	/**
 	 * Check if current request is secure (https)
-	 * @return
+	 * @return boolean TRUE if https, FALSE if http
 	 */
 	public function isSecure()
 	{
@@ -2346,7 +2346,7 @@ class e107
 	 * Safe way to set ini var
 	 * @param string $var
 	 * @param string $value
-	 * @return
+	 * @return TBD
 	 */
 	public static function ini_set($var, $value)
 	{

e107_handlers/file_class.php

@@ -9,9 +9,9 @@
  *
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/file_class.php,v $
- * $Revision: 1.7 $
+ * $Revision: 1.8 $
- * $Date: 2009-12-02 10:03:53 $
+ * $Date: 2009-12-13 21:52:31 $
- * $Author: e107coders $
+ * $Author: e107steved $
  */
 
 if (!defined('e107_INIT')) { exit; }
@@ -80,7 +80,7 @@ class e_file
 	 * @param object $fmask [optional]
 	 * @param object $omit [optional]
 	 * @param object $recurse_level [optional]
-	 * @return 
+	 * @return array of file names/paths
 	 */
 	function get_files($path, $fmask = '', $omit='standard', $recurse_level = 0)
 	{

e107_handlers/form_handler.php

@@ -9,9 +9,9 @@
  * Form Handler
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/form_handler.php,v $
- * $Revision: 1.98 $
+ * $Revision: 1.99 $
- * $Date: 2009-12-13 10:28:15 $
+ * $Date: 2009-12-13 21:52:31 $
- * $Author: secretr $
+ * $Author: e107steved $
  *
 */
 
@@ -203,7 +203,7 @@ class e_form
 	 * @param string $default_name default user name value 
 	 * @param integer $default_id default user id
 	 * @param array|string $options [optional] 'readonly' (make field read only), 'name' (db field name, default user_name) 
-	 * @return 
+	 * @return string HTML text for display
 	 */
 	function userpicker($name_fld, $id_fld, $default_name, $default_id, $options = array())
 	{
@@ -441,7 +441,7 @@ class e_form
 	 * @param object $option_array
 	 * @param object $selected [optional]
 	 * @param object $options [optional]
-	 * @return 
+	 * @return string HTML text for display
 	 */
 	function selectbox($name, $option_array, $selected = false, $options = array())
 	{
@@ -957,7 +957,7 @@ class e_form
 	 * @param array $currentlist - eg $this->fieldpref
 	 * @param array $fieldvalues - eg. $row
 	 * @param string $pid - eg. table_id
-	 * @return 
+	 * @return string
 	 */
 	function renderTableRow($fieldarray, $currentlist, $fieldvalues, $pid)
 	{

e107_handlers/js_helper.php

@@ -9,9 +9,9 @@
  * Javascript Helper
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/js_helper.php,v $
- * $Revision: 1.9 $
+ * $Revision: 1.10 $
- * $Date: 2009-11-18 01:04:43 $
+ * $Date: 2009-12-13 21:52:31 $
- * $Author: e107coders $
+ * $Author: e107steved $
  *
 */
 
@@ -339,7 +339,7 @@ class e_jshelper
      * @param integer $errcode
      * @param string $errmessage
      * @param string $errextended
-     * @access public static
+     * @access public 
      */
     function sendAjaxError($errcode, $errmessage, $errextended = '')
     {

e107_handlers/js_manager.php

@@ -7,9 +7,9 @@
  * GNU General Public License (http://gnu.org).
  * 
  * $Source: /cvs_backup/e107_0.8/e107_handlers/js_manager.php,v $
- * $Revision: 1.8 $
+ * $Revision: 1.9 $
- * $Date: 2009-12-10 22:46:45 $
+ * $Date: 2009-12-13 21:52:31 $
- * $Author: secretr $
+ * $Author: e107steved $
  * 
 */
 global $pref, $eplug_admin, $THEME_JSLIB, $THEME_CORE_JSLIB;
@@ -431,7 +431,7 @@ class e_jsmanager
 	 * @param string $type core|plugin - jslib.php, header|footer|header_inline|footer_inline - runtime
 	 * @param string|array $file_path
 	 * @param string|integer $runtime_location admin|front|all (jslib), 0-5 (runtime inclusion)
-	 * @return 
+	 * @return object $this
 	 */
 	protected function addJs($type, $file_path, $runtime_location = '')
 	{

e107_handlers/mail_manager_class.php

@@ -6,15 +6,22 @@
  * Released under the terms and conditions of the
  * GNU General Public License (http://www.gnu.org/licenses/gpl.txt)
  *
- * e107 Main
+ * e107 Mailout - mail database API and utility routines
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/mail_manager_class.php,v $
- * $Revision: 1.9 $
+ * $Revision: 1.10 $
- * $Date: 2009-11-30 20:40:03 $
+ * $Date: 2009-12-13 21:52:32 $
  * $Author: e107steved $
 */
 
-/*
+/**
+ * 
+ * @package     e107
+ * @category	e107_handlers
+ * @version     $Revision: 1.10 $
+ * @author      $Author: e107steved $
+
+
 This class isolates the caller from the underlying database used to buffer and send emails.
 Also includes a number of useful routines
 
@@ -495,8 +502,8 @@ class e107MailManager
 	/**
 	 * Select the next $count emails in the send queue
 	 * $count gives the maximum number. '*' does 'select all'
-	 * @return Returns FALSE on error.
+	 * @return boolean|handle Returns FALSE on error.
-	 * @return Returns a 'handle' on success (actually the ID in the DB of the email)
+	 * 		 Returns a 'handle' on success (actually the ID in the DB of the email)
 	 */
 	public function selectEmails($count = 1)
 	{
@@ -951,15 +958,15 @@ class e107MailManager
 
 	/**
 	 * Update status for email, including all recipient entries (called once all recipients added)
-	 * @var int $handle - as returned by makeEmail()
+	 * @param int $handle - as returned by makeEmail()
-	 * @var $hold boolean - TRUE to set status to held, false to release for sending
+	 * @param $hold boolean - TRUE to set status to held, false to release for sending
-	 * @var $notify - value to set in the mail_notify_complete field:
+	 * @param $notify - value to set in the mail_notify_complete field:
 	 *			0 - no action on run complete
 	 *			1 - notify admin who sent email only
 	 *			2 - notify through e107 notify system only
 	 *			3 - notify both
-	 * @var $firstTime int - only valid if $hold === FALSE - earliest time/date when email may be sent
+	 * @param $firstTime int - only valid if $hold === FALSE - earliest time/date when email may be sent
-	 * @var $lastTime int - only valid if $hold === FALSE - latest time/date when email may be sent
+	 * @param $lastTime int - only valid if $hold === FALSE - latest time/date when email may be sent
 	 * @return boolean TRUE on no errors, FALSE on errors
 	 */
 	public function activateEmail($handle, $hold = FALSE, $notify = 0, $firstTime = 0, $lastTime = 0)
@@ -1031,7 +1038,7 @@ class e107MailManager
 
 	/**
 	 * Put email on hold, including marking all unsent recipient entries
-	 * @var integer $handle - as returned by makeEmail()
+	 * @param integer $handle - as returned by makeEmail()
 	 * @return boolean - TRUE on success, FALSE on failure
 	 */
 	public function holdEmail($handle)
@@ -1055,8 +1062,8 @@ class e107MailManager
 
 	/**
 	 * Handle a bounce report. 
-	 * @var string $bounceString - the string from header X-e107-id
+	 * @param string $bounceString - the string from header X-e107-id
-	 * @var string $emailAddress - optional email address string for checks
+	 * @param string $emailAddress - optional email address string for checks
 	 * @return boolean - TRUE on success, FALSE on failure
 	 */
 	public function markBounce($bounceString, $emailAddress = '')
@@ -1144,10 +1151,10 @@ class e107MailManager
 
 	/**
 	 * Does a query to select one or more emails for which status is required.
-	 * @var $start - sets the offset of the first email to return based on the search criteria
+	 * @param $start - sets the offset of the first email to return based on the search criteria
-	 * @var $count - sets the maximum number of emails to return
+	 * @param $count - sets the maximum number of emails to return
-	 * @var $fields - allows selection of which db fields are returned in each result
+	 * @param $fields - allows selection of which db fields are returned in each result
-	 * @var $filters - array contains filter/selection criteria - basically setting limits on each field
+	 * @param $filters - array contains filter/selection criteria - basically setting limits on each field
 	 * @return Returns number of records found (maximum $count); FALSE on error
 	 */
 	public function selectEmailStatus($start = 0, $count = 0, $fields = '*', $filters = FALSE, $orderField = 'mail_source_id', $sortOrder = 'asc')
@@ -1242,10 +1249,10 @@ class e107MailManager
 
 	/**
 	 * Does a query to select from the list of email targets which have been used
-	 * @var $start - sets the offset of the first email to return based on the search criteria
+	 * @param $start - sets the offset of the first email to return based on the search criteria
-	 * @var $count - sets the maximum number of emails to return
+	 * @param $count - sets the maximum number of emails to return
-	 * @var $fields - allows selection of which db fields are returned in each result
+	 * @param $fields - allows selection of which db fields are returned in each result
-	 * @var $filters - array contains filter/selection criteria
+	 * @param $filters - array contains filter/selection criteria
 	 *				'handle=nn' picks out a specific email
 	 * @return Returns number of records found; FALSE on error
 	 */

e107_handlers/message_handler.php

@@ -9,9 +9,9 @@
  * Message Handler
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/message_handler.php,v $
- * $Revision: 1.27 $
+ * $Revision: 1.28 $
- * $Date: 2009-11-18 01:04:43 $
+ * $Date: 2009-12-13 21:52:32 $
- * $Author: e107coders $
+ * $Author: e107steved $
  *
 */
 
@@ -120,7 +120,7 @@ class eMessage
 	/**
 	 * Set message session id
 	 * @param string $name 
-	 * @return 
+	 * @return object $this
 	 */
 	public function setSessionId($name)
 	{

e107_handlers/model_class.php

@@ -9,9 +9,9 @@
  * e107 Base Model
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/model_class.php,v $
- * $Revision: 1.48 $
+ * $Revision: 1.49 $
- * $Date: 2009-12-10 22:46:45 $
+ * $Date: 2009-12-13 21:52:32 $
- * $Author: secretr $
+ * $Author: e107steved $
 */
 
 if (!defined('e107_INIT')) { exit; }
@@ -1582,7 +1582,7 @@ class e_admin_model extends e_model
 	 * @param string $message
 	 * @param string $field_title [optional]
 	 * @param integer $error_code [optional]
-	 * @return 
+	 * @return object
 	 */
 	public function addValidationError($message, $field_title = '', $error_code = '')
 	{

e107_handlers/plugin_class.php

@@ -9,8 +9,8 @@
  * Administration - Site Maintenance
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/plugin_class.php,v $
- * $Revision: 1.119 $
+ * $Revision: 1.120 $
- * $Date: 2009-12-11 21:17:09 $
+ * $Date: 2009-12-13 21:52:32 $
  * $Author: e107steved $
  *
 */
@@ -902,7 +902,7 @@ class e107plugin
 	 * 			'delete_xfields' - to delete extended fields
 	 * 			'delete_ipool' - to delete icon pool entry
 	 * 			+ any defined in <pluginname>_setup.php in the uninstall_options() method.
-	 * @return
+	 * @return TBD
 	 */
 	function install_plugin_xml($id, $function='', $options = FALSE)
 	{
@@ -1217,7 +1217,7 @@ class e107plugin
 	 * Process XML Tag <LanguageFiles>
 	 * @param object $function
 	 * @param object $tag
-	 * @return
+	 * @return none
 	 */
 	function XmlLanguageFiles($function,$tag,$when='')
 	{
@@ -1261,7 +1261,7 @@ class e107plugin
 	 * Process XML Tag <siteLinks>
 	 * @param string $function install|upgrade|refresh|uninstall
 	 * @param array $array
-	 * @return
+	 * @return none
 	 */
 	function XmlSiteLinks($function,$array)
 	{
@@ -1307,7 +1307,7 @@ class e107plugin
 
 	/**
 	 * Process XML Tag <adminLinks>
-	 * @return
+	 * @return none
 	 */
 	function XmlAdminLinks($function,$tag)
 	{
@@ -1329,7 +1329,7 @@ class e107plugin
 	 * Process XML Tag <userClasses>
 	 * @param string $function install|upgrade|refresh|uninstall
 	 * @param array $array
-	 * @return
+	 * @return none
 	 */
 	function XmlUserClasses($function,$array)
 	{
@@ -1386,7 +1386,7 @@ class e107plugin
 	 * Process XML Tag <extendedFields>
 	 * @param string $function install|upgrade|refresh|uninstall
 	 * @param array $array
-	 * @return
+	 * @return none
 	 */
 	function XmlExtendedFields($function,$array)
 	{
@@ -1442,7 +1442,7 @@ class e107plugin
 	 * @param object $mode 'core' or the folder name of the plugin.
 	 * @param object $function install|uninstall|upgrade|refresh
 	 * @param object $prefArray XML array of prefs. eg. mainPref() or pluginPref();
-	 * @return
+	 * @return none
 	 */
 	function XmlPrefs($mode='core',$function,$prefArray)
 	{
@@ -1517,7 +1517,7 @@ class e107plugin
 	 * @param object $path [unused]
 	 * @param object $what install|uninstall|upgrade
 	 * @param object $when pre|post
-	 * @return
+	 * @return boolean FALSE
 	 */
 	function execute_function($path = '', $what='', $when='')
 	{

e107_handlers/pref_class.php

@@ -9,8 +9,8 @@
  * e107 Preference Handler
  *
  * $Source: /cvs_backup/e107_0.8/e107_handlers/pref_class.php,v $
- * $Revision: 1.33 $
+ * $Revision: 1.34 $
- * $Date: 2009-12-09 20:35:58 $
+ * $Date: 2009-12-13 21:52:32 $
  * $Author: e107steved $
 */
 
@@ -971,7 +971,7 @@ class prefs
 	* @param  string val -- pre-serialized string
 	* @param  string $name -- name of pref row
 	* @param  string $table -- "core" or "user"
-	* @global  $$name
+	* @global  mixed $$name
 	* @access  public
 	*
 	* set("val")    == 'core', 'pref'

e107_handlers/redirection_class.php

@@ -11,9 +11,9 @@
  |     GNU General Public License (http://gnu.org).
  |
  |     $Source: /cvs_backup/e107_0.8/e107_handlers/redirection_class.php,v $
- |     $Revision: 1.8 $
+ |     $Revision: 1.9 $
- |     $Date: 2009-11-22 14:10:07 $
+ |     $Date: 2009-12-13 21:52:32 $
- |     $Author: e107coders $
+ |     $Author: e107steved $
  +----------------------------------------------------------------------------+
  */
 
@@ -59,7 +59,7 @@ class redirection
 	
 	/**
 	 * Store the current URL in a cookie for 5 minutes so we can return to it after being logged out. 
-	 * @return 
+	 * @return none
 	 */
 	function setPreviousUrl()
 	{
@@ -84,7 +84,7 @@ class redirection
 	
 	/**
 	 * Return the URL the admin was on, prior to being logged-out. 
-	 * @return 
+	 * @return string 
 	 */
 	public function getPreviousUrl()
 	{		

e107_plugins/calendar_menu/languages/English.php

@@ -9,8 +9,8 @@
  * These messages are for the 'user' pages of the event calendar (including event entry/editing)
  *
  * $Source: /cvs_backup/e107_0.8/e107_plugins/calendar_menu/languages/English.php,v $
- * $Revision: 1.10 $
+ * $Revision: 1.11 $
- * $Date: 2009-11-22 10:11:32 $
+ * $Date: 2009-12-13 21:52:32 $
  * $Author: e107steved $
  */
 	
@@ -243,6 +243,7 @@ define('EC_LAN_177', "Cancel Entry");
 define('EC_LAN_178', "Accept Entries");
 define('EC_LAN_179', "Confirmation of multiple event entry");
 define('EC_LAN_180', 'RECORDS NOT SAVED - DB UPDATE ERROR');
+define('EC_LAN_181', "You aren't allowed to do that!");
 
 define('EC_LAN_VIEWCALENDAR', 'View Calendar');
 define('EC_LAN_VIEWALLEVENTS', 'View all events');

e107_plugins/pm/pm_shortcodes.php

@@ -9,8 +9,8 @@
  *
  *
  * $Source: /cvs_backup/e107_0.8/e107_plugins/pm/pm_shortcodes.php,v $
- * $Revision: 1.14 $
+ * $Revision: 1.15 $
- * $Date: 2009-12-10 20:40:38 $
+ * $Date: 2009-12-13 21:52:32 $
  * $Author: e107steved $
  */
 
@@ -254,7 +254,7 @@ SC_BEGIN PM_FROM
 global $pm_info;
 if("link" == $parm)
 {
-	return "<a href='".e_BASE."user.php?id.{$pm_info['pm_from']}'>{$pm_info['user_name']}</a>";
+	return "<a href='".e_HTTP."user.php?id.{$pm_info['pm_from']}'>{$pm_info['user_name']}</a>";
 }
 else
 {
@@ -320,7 +320,7 @@ if(is_numeric($pm_info['pm_to']))
 {
 	if("link" == $parm)
 	{
-		return "<a href='".e_BASE."user.php?id.{$pm_info['pm_to']}'>{$pm_info['user_name']}</a>";
+		return "<a href='".e_HTTP."user.php?id.{$pm_info['pm_to']}'>{$pm_info['user_name']}</a>";
 	}
 	else
 	{
@@ -409,7 +409,7 @@ if (!$pmBlocked['user_name'])
 }
 if('link' == $parm)
 {
-	return "<a href='".e_BASE."user.php?id.{$pmBlocked['pm_block_from']}'>{$pmBlocked['user_name']}</a>";
+	return "<a href='".e_HTTP."user.php?id.{$pmBlocked['pm_block_from']}'>{$pmBlocked['user_name']}</a>";
 }
 else
 {