EGroupware / egroupware

resources/inc/class.resources_favorite_portlet.inc.php

Doc Comments -2 removed lines

@@ -86,8 +86,6 @@
 	 * Here we need to handle any incoming data.  Setup is done in the constructor,
 	 * output is handled by parent.
 	 *
-	 * @param type $id
-	 * @param etemplate_new $etemplate
 	 */
 	public static function process($content = array())
 	{

phpgwapi/inc/adodb/adodb.inc.php

Doc Comments +42 added lines, -26 removed lines

@@ -129,6 +129,8 @@ 
 
 	/**
 	 	Accepts $src and $dest arrays, replacing string $data
+	* @param string[] $src
+	* @param string[] $dest
 	*/
 	function ADODB_str_replace($src, $dest, $data)
 	{
@@ -432,6 +434,12 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param string $argHostname
+	 * @param string $argUsername
+	 * @param string $argPassword
+	 * @param string $argDatabaseName
+	 */
 	function _nconnect($argHostname, $argUsername, $argPassword, $argDatabaseName)
 	{
 		return $this->_connect($argHostname, $argUsername, $argPassword, $argDatabaseName);
@@ -540,6 +548,7 @@ 
 
 	/**
 	* PEAR DB Compat
+	* @param string $s
 	*/
 	function Quote($s)
 	{
@@ -926,7 +935,7 @@ 
 	 * GenID is only available if $this->hasGenID = true;
 	 *
 	 * @param seqname		name of sequence to use
-	 * @param startID		if sequence does not exist, start at this ID
+	 * @param startID		integer sequence does not exist, start at this ID
 	 * @return		0 if not supported, otherwise a sequence id
 	 */
 	function GenID($seqname='adodbseq',$startID=1)
@@ -1008,7 +1017,7 @@ 
 
 
 	/**
-	 * @return  the last error message
+	 * @return  string last error message
 	 */
 	function ErrorMsg()
 	{
@@ -1018,7 +1027,7 @@ 
 
 
 	/**
-	 * @return the last error number. Normally 0 means no error.
+	 * @return integer last error number. Normally 0 means no error.
 	 */
 	function ErrorNo()
 	{
@@ -1069,7 +1078,7 @@ 
 	 * Choose a database to connect to. Many databases do not support this.
 	 *
 	 * @param dbName 	is the name of the database to select
-	 * @return 		true or false
+	 * @return 		boolean or false
 	 */
 	function SelectDB($dbName)
 	{return false;}
@@ -1542,6 +1551,8 @@ 
 	* When not in safe mode, we create 256 sub-directories in the cache directory ($ADODB_CACHE_DIR).
 	* Assuming that we can have 50,000 files per directory with good performance,
 	* then we can scale to 12.8 million unique cached recordsets. Wow!
+ 	* @param string $sql
+ 	* @param boolean $createdir
  	*/
 	function _gencachename($sql,$createdir)
 	{
@@ -1913,7 +1924,7 @@ 
 	/**
 	 * Begin a Transaction. Must be followed by CommitTrans() or RollbackTrans().
 	 *
-	 * @return true if succeeded or false if database does not support transactions
+	 * @return boolean if succeeded or false if database does not support transactions
 	 */
 	function BeginTrans() {return false;}
 
@@ -2082,7 +2093,7 @@ 
       * @param table  table name to query
       * @param primary true to only show primary keys. Not actually used for most databases
 	  *
-      * @return array of indexes on current table. Each element represents an index, and is itself an associative array.
+      * @return boolean of indexes on current table. Each element represents an index, and is itself an associative array.
 
 		 Array (
 		    [name_of_index] => Array
@@ -2132,7 +2143,7 @@ 
 	 *
 	 * Usage: $db->Concat($str1,$str2);
 	 *
-	 * @return concatenated string
+	 * @return string string
 	 */
 	function Concat()
 	{
@@ -2146,7 +2157,7 @@ 
 	 *
 	 * @param d	a date in Unix date time format.
 	 *
-	 * @return  date string in database date format
+	 * @return  string string in database date format
 	 */
 	function DBDate($d)
 	{
@@ -2167,7 +2178,7 @@ 
 	 *
 	 * @param ts	a timestamp in Unix date time format.
 	 *
-	 * @return  timestamp string in database timestamp format
+	 * @return  string string in database timestamp format
 	 */
 	function DBTimeStamp($ts)
 	{
@@ -2538,7 +2549,7 @@ 
 	 & @param [compareFields0]	when we have 2 cols in recordset, we compare the defstr with
 	 *				column 0 (1st col) if this is true. This is not documented.
 	 *
-	 * @return HTML
+	 * @return string
 	 *
 	 * changes by glen.davies@cce.ac.nz to support multiple hilited items
 	 */
@@ -2618,7 +2629,7 @@ 
 	 * return recordset as a 2-dimensional array.
 	 * Helper function for ADOConnection->SelectLimit()
 	 *
-	 * @param offset	is the row to start calculations from (1-based)
+	 * @param offset	integer the row to start calculations from (1-based)
 	 * @param [nrows]	is the number of rows to return
 	 *
 	 * @return an array indexed by the rows (0-based) from the recordset
@@ -2871,7 +2882,7 @@ 
 	/**
 	 * Move to the first row in the recordset. Many databases do NOT support this.
 	 *
-	 * @return true or false
+	 * @return boolean or false
 	 */
 	function MoveFirst()
 	{
@@ -2883,7 +2894,7 @@ 
 	/**
 	 * Move to the last row in the recordset.
 	 *
-	 * @return true or false
+	 * @return boolean or false
 	 */
 	function MoveLast()
 	{
@@ -2902,7 +2913,7 @@ 
 	/**
 	 * Move to next record in the recordset.
 	 *
-	 * @return true if there still rows available, or false if there are no more rows (EOF).
+	 * @return boolean if there still rows available, or false if there are no more rows (EOF).
 	 */
 	function MoveNext()
 	{
@@ -2926,9 +2937,9 @@ 
 	 * Random access to a specific row in the recordset. Some databases do not support
 	 * access to previous rows in the databases (no scrolling backwards).
 	 *
-	 * @param rowNumber is the row to move to (0-based)
+	 * @param rowNumber integer the row to move to (0-based)
 	 *
-	 * @return true if there still rows available, or false if there are no more rows (EOF).
+	 * @return boolean if there still rows available, or false if there are no more rows (EOF).
 	 */
 	function Move($rowNumber = 0)
 	{
@@ -3024,7 +3035,7 @@ 
 	/**
 	 * Clean up recordset
 	 *
-	 * @return true or false
+	 * @return null|boolean or false
 	 */
 	function Close()
 	{
@@ -3041,7 +3052,7 @@ 
 	/**
 	 * synonyms RecordCount and RowCount
 	 *
-	 * @return the number of rows or -1 if this is not supported
+	 * @return integer number of rows or -1 if this is not supported
 	 */
 	function RecordCount() {return $this->_numOfRows;}
 
@@ -3058,7 +3069,7 @@ 
 	/**
 	 * synonyms RecordCount and RowCount
 	 *
-	 * @return the number of rows or -1 if this is not supported
+	 * @return integer number of rows or -1 if this is not supported
 	 */
 	function RowCount() {return $this->_numOfRows;}
 
@@ -3086,19 +3097,19 @@ 
 	}
 
 	/**
-	 * @return the current row in the recordset. If at EOF, will return the last row. 0-based.
+	 * @return integer current row in the recordset. If at EOF, will return the last row. 0-based.
 	 */
 	function CurrentRow() {return $this->_currentRow;}
 
 	/**
 	 * synonym for CurrentRow -- for ADO compat
 	 *
-	 * @return the current row in the recordset. If at EOF, will return the last row. 0-based.
+	 * @return integer current row in the recordset. If at EOF, will return the last row. 0-based.
 	 */
 	function AbsolutePosition() {return $this->_currentRow;}
 
 	/**
-	 * @return the number of columns in the recordset. Some databases will set this to 0
+	 * @return integer number of columns in the recordset. Some databases will set this to 0
 	 * if no records are returned, others will return the number of columns in the query.
 	 */
 	function FieldCount() {return $this->_numOfFields;}
@@ -3107,7 +3118,7 @@ 
 	/**
 	 * Get the ADOFieldObject of a specific column.
 	 *
-	 * @param fieldoffset	is the column position to access(0-based).
+	 * @param fieldoffset	integer the column position to access(0-based).
 	 *
 	 * @return the ADOFieldObject for that column, or false.
 	 */
@@ -3217,7 +3228,7 @@ 
 	 * type to our standardised version which uses 1 character codes:
 	 *
 	 * @param t  is the type passed in. Normally is ADOFieldObject->type.
-	 * @param len is the maximum length of that field. This is because we treat character
+	 * @param len integer the maximum length of that field. This is because we treat character
 	 * 	fields bigger than a certain size as a 'B' (blob).
 	 * @param fieldobj is the field object returned by the database driver. Can hold
 	 *	additional info (eg. primary_key for mysql).
@@ -3409,7 +3420,8 @@ 
 	 * PDO compatibility function: fetch the next row
 	 *
 	 * @param $fetchmode=null ADODB_FETCH_{DEFAULT|ASSOC|NUM|BOTH}, default is to use currently selected fetch-mode
-	 * @return array|boolean false if there's nothing to fetch
+	 * @param integer $fetchmode
+	 * @return boolean false if there's nothing to fetch
 	 */
 	function &fetch($fetchmode=null)
 	{
@@ -3429,7 +3441,7 @@ 
 	/**
 	 * PDO compatibility function: fetch the n-th column of the next row
 	 *
-	 * @param int $column_number=0
+	 * @param int $column_number
 	 * @return string|boolean false if there's nothing to fetch
 	 */
 	function fetchColumn($column_number=0)
@@ -3828,6 +3840,10 @@ 
 
 
 	// $perf == true means called by NewPerfMonitor(), otherwise for data dictionary
+
+	/**
+	 * @return string
+	 */
 	function _adodb_getdriver($provider,$drivername,$perf=false)
 	{
 		switch ($provider) {