PHPdoc fix

e107_plugins/list_new/list_admin_class.php

@@ -9,8 +9,8 @@
  * List Admin Class
  *
  * $Source: /cvs_backup/e107_0.8/e107_plugins/list_new/list_admin_class.php,v $
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
- * $Date: 2009-07-25 07:54:35 $
+ * $Date: 2009-11-17 14:05:34 $
  * $Author: marj_nl_fr $
  *
 */
@@ -45,7 +45,7 @@ class list_admin
 	/**
 	 * database update settings
 	 * 
-	 * @return sting $message
+	 * @return string $message
 	 * 
 	 */
 	function db_update_menu()

e107_plugins/tinymce/admin_config.php

@@ -9,9 +9,9 @@
  * Plugin Administration - gsitemap
  *
  * $Source: /cvs_backup/e107_0.8/e107_plugins/tinymce/admin_config.php,v $
- * $Revision: 1.10 $
+ * $Revision: 1.11 $
- * $Date: 2009-11-09 16:54:30 $
+ * $Date: 2009-11-17 14:05:34 $
- * $Author: secretr $
+ * $Author: marj_nl_fr $
  *
 */
 require_once("../../class2.php");
@@ -128,10 +128,11 @@ class tinymce
 // --------------------------------------------------------------------------
 	/**
 	 * Generic DB Record Listing Function. 
-	 * @param object $mode [optional]
+	 *
-	 * @return 
+	 * @param object $mode [optional] - reserved
+	 * @return void
 	 */
-	function listRecords($mode=FALSE)
+	function listRecords($mode = FALSE)
 	{
 		$ns = e107::getRender();
 		$sql = e107::getDb();
@@ -184,11 +185,12 @@ class tinymce
 
 	/**
 	 * Render Field value (listing page)
-	 * @param object $key
+	 *
-	 * @param object $row
+	 * @param array $key
-	 * @return 
+	 * @param array $row
+	 * @return string
 	 */
-	function renderValue($key,$row)
+	function renderValue($key, $row)
 	{
 		$att = $this->fields[$key];	
 		$frm = e107::getForm();	
@@ -226,13 +228,14 @@ class tinymce
 	
 	/**
 	 * Render Form Element (edit page)
-	 * @param object $key
+	 *
-	 * @param object $row
+	 * @param array $key
-	 * @return 
+	 * @param array $row
+	 * @return string method's value or HTML input
 	 */
-	function renderElement($key,$row)
+	function renderElement($key, $row)
 	{
-		global $frm;
+		$frm = e107::getForm();
 		$att = $this->fields[$key];
 		$value = $row[$key];	
 		
@@ -241,7 +244,7 @@ class tinymce
 			$meth = $att['method'];
 			if(isset($att['methodparms']))
 			{
-				return $this->$meth($value,$att['methodparms']);
+				return $this->$meth($value, $att['methodparms']);
 			}
 			return $this->$meth($value);
 		}
@@ -377,11 +380,13 @@ class tinymce
 
 
 	/**
-	 * Generic Save DB Record Function. 
+	 * Generic Save DB Record Function.
-	 * @param object $id [optional]
+	 * Insert or Update a table row.
-	 * @return 
+	 *
+	 * @param mixed $id [optional] if set, $id correspond to the primary key of the table
+	 * @return void
 	 */
-	function submitPage($id=FALSE)
+	function submitPage($id = FALSE)
 	{
 		global $sql, $tp, $e107cache, $admin_log, $e_event;
 		$emessage = eMessage::getInstance();

install_.php

@@ -9,8 +9,8 @@
 * Installation file
 *
 * $Source: /cvs_backup/e107_0.8/install_.php,v $
-* $Revision: 1.51 $
+* $Revision: 1.52 $
-* $Date: 2009-11-17 10:31:05 $
+* $Date: 2009-11-17 14:05:34 $
 * $Author: marj_nl_fr $
 *
 */
@@ -605,7 +605,8 @@ class e_install
 
 	/**
 	 * Collect Admin Login Data.
-	 * @return 
+	 *
+	 * @return string HTML form of stage 5.
 	 */
 
 	private function stage_5()  
@@ -660,9 +661,10 @@ class e_install
 		$this->template->SetTag("stage_content", $e_forms->return_form());
 	}
 	
-	/** Collect User's Website Preferences
+	/**
+	 * Collect User's Website Preferences
 	 * 
-	 * @return html form. 
+	 * @return string HTML form of stage 6.
 	 */
 	private function stage_6()  
 	{
@@ -940,9 +942,11 @@ class e_install
 
 
 	/**
-	 * Import and Generate Preferences and default content.
+	 * Import and generate preferences and default content.
-	 * @return 
+	 *
+	 * @return boolean
 	 */
+	 //FIXME always return FALSE???
 	public function import_configuration()
 	{
 		// Basic stuff to get the handlers/classes to work.
@@ -1051,6 +1055,7 @@ class e_install
 
 	/**
 	 * Install a Theme required plugin.
+	 *
 	 * @param string $plugpath - plugin folder name
 	 * @return void
 	 */
@@ -1067,8 +1072,9 @@ class e_install
 	 * Check a DB name or table prefix - anything starting with a numeric followed by 'e' causes problems.
 	 * Return TRUE if acceptable, FALSE if unacceptable
 	 * Empty string returns the value of $blank_ok (caller should set TRUE for prefix, FALSE for DB name)
-	 * @param object $str
+	 *
-	 * @param object $blank_ok [optional]
+	 * @param string $str
+	 * @param boolean $blank_ok [optional]
 	 * @return boolean
 	 */
 	function check_name($str, $blank_ok = FALSE)
@@ -1204,6 +1210,7 @@ class e_install
 
 	/**
 	 * Create Core MySQL tables
+	 *
 	 * @return 
 	 */
 	public function create_tables()