Added and improved PHPDoc (adodb.inc.php)

Fixes #445

Signed-off-by: Damien Regad <dregad@mantisbt.org>

Rebased, conflicts resolved, fixed whitespace (indent with spaces).

1 files changed, 212 insertions, 148 deletions

diff --git a/adodb.inc.php b/adodb.inc.php
index 556e0a35..511f91c4 100644
--- a/adodb.inc.php
+++ b/adodb.inc.php
@@ -545,13 +545,17 @@ if (!defined('_ADODB_LAYER')) {
 	*
 	* @example, for mssqlnative driver ('CharacterSet','UTF-8')
 	*/
-	final public function setConnectionParameter($parameter,$value)
-	{
+	final public function setConnectionParameter($parameter,$value) {
 
 		$this->connectionParameters[] = array($parameter=>$value);
 
 	}
 
+	/**
+	 * ADOdb version.
+	 *
+	 * @return string
+	 */
 	static function Version() {
 		global $ADODB_vers;
 
@@ -573,15 +577,20 @@ if (!defined('_ADODB_LAYER')) {
 	}
 
 	/**
-		Get server version info...
-
-		@returns An array with 2 elements: $arr['string'] is the description string,
-			and $arr[version] is the version (also a string).
-	*/
+	 * Get server version info.
+	 *
+	 * @return string[] An array with 2 elements: $arr['string'] is the description string,
+	 *				 	and $arr[version] is the version (also a string).
+	 */
 	function ServerInfo() {
 		return array('description' => '', 'version' => '');
 	}
 
+	/**
+	 * Return true if connected to the database.
+	 *
+	 * @return bool
+	 */
 	function IsConnected() {
 		return !empty($this->_connectionID);
 	}
@@ -595,9 +604,13 @@ if (!defined('_ADODB_LAYER')) {
 	}
 
 	/**
-	* All error messages go through this bottleneck function.
-	* You can define your own handler by defining the function name in ADODB_OUTP.
-	*/
+	 * All error messages go through this bottleneck function.
+	 *
+	 * You can define your own handler by defining the function name in ADODB_OUTP.
+	 *
+	 * @param string $msg     Message to print
+	 * @param bool   $newline True to add a newline after printing $msg
+	 */
 	static function outp($msg,$newline=true) {
 		global $ADODB_FLUSH,$ADODB_OUTP;
 
@@ -627,6 +640,10 @@ if (!defined('_ADODB_LAYER')) {
 
 	}
 
+	/**
+	 * Return the database server's current date and time.
+	 * @return int|false
+	 */
 	function Time() {
 		$rs = $this->_Execute("select $this->sysTimeStamp");
 		if ($rs && !$rs->EOF) {
@@ -884,6 +901,8 @@ if (!defined('_ADODB_LAYER')) {
 
 	/**
 	 * Requested by "Karsten Dambekalns" <k.dambekalns@fishfarm.de>
+	 *
+	 * @return string
 	 */
 	function QMagic($s) {
 		return $this->qstr($s,get_magic_quotes_gpc());
@@ -915,17 +934,26 @@ if (!defined('_ADODB_LAYER')) {
 	 * Lock a row, will escalate and lock the table if row locking not supported
 	 * will normally free the lock at the end of the transaction
 	 *
-	 * @param $table	name of table to lock
-	 * @param $where	where clause to use, eg: "WHERE row=12". If left empty, will escalate to table lock
+	 * @param string $table	name of table to lock
+	 * @param string $where	where clause to use, eg: "WHERE row=12". If left empty, will escalate to table lock
+     * @param string $col
 	 */
 	function RowLock($table,$where,$col='1 as adodbignore') {
 		return false;
 	}
 
+	/**
+	 * @param string $table
+	 * @return true
+	 */
 	function CommitLock($table) {
 		return $this->CommitTrans();
 	}
 
+	/**
+	 * @param string $table
+	 * @return true
+	 */
 	function RollbackLock($table) {
 		return $this->RollbackTrans();
 	}
@@ -937,7 +965,7 @@ if (!defined('_ADODB_LAYER')) {
 	* for easy porting :-)
 	*
 	* @param int $mode The fetchmode ADODB_FETCH_ASSOC or ADODB_FETCH_NUM
-	 *
+	*
 	* @return int Previous fetch mode
 	*/
 	function SetFetchMode($mode) {
@@ -1437,8 +1465,12 @@ if (!defined('_ADODB_LAYER')) {
 	/**
 	 * Portable Insert ID. Pablo Roca <pabloroca#mvps.org>
 	 *
-	 * @return  the last inserted ID. All databases support this. But aware possible
-	 * problems in multiuser environments. Heavy test this before deploying.
+	 * @param string $table
+	 * @param string $id
+	 
+	 * @return mixed The last inserted ID. All databases support this, but be 
+	 *               aware of possible problems in multiuser environments.
+	 *               Heavily test this before deploying.
 	 */
 	function PO_Insert_ID($table="", $id="") {
 		if ($this->hasInsertID){
@@ -1717,8 +1749,7 @@ if (!defined('_ADODB_LAYER')) {
 	 * @return array|false
 	*/
 	function GetAll($sql, $inputarr=false) {
-		$arr = $this->GetArray($sql,$inputarr);
-		return $arr;
+        return $this->GetArray($sql,$inputarr);
 	}
 
 	/**
@@ -1933,8 +1964,7 @@ if (!defined('_ADODB_LAYER')) {
 		$ADODB_COUNTRECS = $savec;
 		if (!$rs)
 			if (defined('ADODB_PEAR')) {
-				$cls = ADODB_PEAR_Error();
-				return $cls;
+				return ADODB_PEAR_Error();
 			} else {
 				return false;
 			}
@@ -1944,8 +1974,7 @@ if (!defined('_ADODB_LAYER')) {
 	}
 
 	function CacheGetAll($secs2cache,$sql=false,$inputarr=false) {
-		$arr = $this->CacheGetArray($secs2cache,$sql,$inputarr);
-		return $arr;
+		return $this->CacheGetArray($secs2cache,$sql,$inputarr);
 	}
 
 	function CacheGetArray($secs2cache,$sql=false,$inputarr=false) {
@@ -1958,8 +1987,7 @@ if (!defined('_ADODB_LAYER')) {
 
 		if (!$rs)
 			if (defined('ADODB_PEAR')) {
-				$cls = ADODB_PEAR_Error();
-				return $cls;
+				return ADODB_PEAR_Error();
 			} else {
 				return false;
 			}
@@ -2005,6 +2033,12 @@ if (!defined('_ADODB_LAYER')) {
 		return false;
 	}
 
+	/**
+	 * @param int $secs2cache
+	 * @param string|false $sql
+	 * @param mixed[]|bool $inputarr
+	 * @return mixed[]|bool
+	 */
 	function CacheGetRow($secs2cache,$sql=false,$inputarr=false) {
 		$rs = $this->CacheExecute($secs2cache,$sql,$inputarr);
 		if ($rs) {
@@ -2930,9 +2964,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	/**
 	 * Converts a timestamp "ts" to a string that the database can understand.
 	 *
-	 * @param ts	a timestamp in Unix date time format.
+	 * @param int|object $ts A timestamp in Unix date time format.
 	 *
-	 * @return  timestamp string in database timestamp format
+	 * @return string $timestamp string in database timestamp format
 	 */
 	function DBTimeStamp($ts,$isfld=false) {
 		if (empty($ts) && $ts !== 0) {
@@ -2963,9 +2997,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 	/**
 	 * Also in ADORecordSet.
-	 * @param $v is a date string in YYYY-MM-DD format
+	 * @param mixed $v is a date string in YYYY-MM-DD format
 	 *
-	 * @return date in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format
+	 * @return int|false Date in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format
 	 */
 	static function UnixDate($v) {
 		if (is_object($v)) {
@@ -2992,9 +3026,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 	/**
 	 * Also in ADORecordSet.
-	 * @param $v is a timestamp string in YYYY-MM-DD HH-NN-SS format
+	 * @param string|object $v is a timestamp string in YYYY-MM-DD HH-NN-SS format
 	 *
-	 * @return date in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format
+	 * @return int|false Date in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format
 	 */
 	static function UnixTimeStamp($v) {
 		if (is_object($v)) {
@@ -3019,14 +3053,15 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	}
 
 	/**
-	 * Also in ADORecordSet.
-	 *
 	 * Format database date based on user defined format.
 	 *
-	 * @param v		is the character date in YYYY-MM-DD format, returned by database
-	 * @param fmt	is the format to apply to it, using date()
+	 * Also in ADORecordSet.
+	 *
+	 * @param mixed  $v    Date in YYYY-MM-DD format, returned by database
+	 * @param string $fmt  Format to apply, using date()
+	 * @param bool   $gmt
 	 *
-	 * @return a date formatted as user desires
+	 * @return string Formatted date
 	 */
 	function UserDate($v,$fmt='Y-m-d',$gmt=false) {
 		$tt = $this->UnixDate($v);
@@ -3045,11 +3080,13 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	}
 
 	/**
+	 * Format timestamp based on user defined format.
 	 *
-	 * @param v		is the character timestamp in YYYY-MM-DD hh:mm:ss format
-	 * @param fmt	is the format to apply to it, using date()
+	 * @param mixed  $v    Date in YYYY-MM-DD hh:mm:ss format
+	 * @param string $fmt  Format to apply, using date()
+	 * @param bool   $gmt
 	 *
-	 * @return a timestamp formatted as user desires
+	 * @return string Formatted timestamp
 	 */
 	function UserTimeStamp($v,$fmt='Y-m-d H:i:s',$gmt=false) {
 		if (!isset($v)) {
@@ -3070,13 +3107,22 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 		return ($gmt) ? adodb_gmdate($fmt,$tt) : adodb_date($fmt,$tt);
 	}
 
+	/**
+	 * @param string $s
+	 * @param bool [$magic_quotes]
+	 * @return mixed
+	 */
 	function escape($s,$magic_quotes=false) {
 		return $this->addq($s,$magic_quotes);
 	}
 
 	/**
-	* Quotes a string, without prefixing nor appending quotes.
-	*/
+	 * Quotes a string, without prefixing nor appending quotes.
+	 *
+	 * @param string $s
+	 * @param bool [$magic_quotes]
+	 * @return mixed
+	 */
 	function addq($s,$magic_quotes=false) {
 		if (!$magic_quotes) {
 			if ($this->replaceQuote[0] == '\\') {
@@ -3136,22 +3182,21 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 
 	/**
-	* Will select the supplied $page number from a recordset, given that it is paginated in pages of
-	* $nrows rows per page. It also saves two boolean values saying if the given page is the first
-	* and/or last one of the recordset. Added by Iván Oliva to provide recordset pagination.
-	*
-	* See docs-adodb.htm#ex8 for an example of usage.
-	*
-	* @param sql
-	* @param nrows		is the number of rows per page to get
-	* @param page		is the page number to get (1-based)
-	* @param [inputarr]	array of bind variables
-	* @param [secs2cache]		is a private parameter only used by jlim
-	* @return		the recordset ($rs->databaseType == 'array')
-	*
-	* NOTE: phpLens uses a different algorithm and does not use PageExecute().
-	*
-	*/
+	 * Will select the supplied $page number from a recordset, given that it is paginated in pages of
+	 * $nrows rows per page. It also saves two boolean values saying if the given page is the first
+	 * and/or last one of the recordset. Added by Iván Oliva to provide recordset pagination.
+	 *
+	 * See docs-adodb.htm#ex8 for an example of usage.
+	 * NOTE: phpLens uses a different algorithm and does not use PageExecute().
+	 *
+	 * @param string $sql
+	 * @param int    $nrows          Number of rows per page to get
+	 * @param int    $page           Page number to get (1-based)
+	 * @param mixed[]|bool $inputarr Array of bind variables
+	 * @param int    $secs2cache     Private parameter only used by jlim
+	 *
+	 * @return mixed		the recordset ($rs->databaseType == 'array')
+	 */
 	function PageExecute($sql, $nrows, $page, $inputarr=false, $secs2cache=0) {
 		global $ADODB_INCLUDED_LIB;
 		if (empty($ADODB_INCLUDED_LIB)) {
@@ -3171,12 +3216,12 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	* $nrows rows per page. It also saves two boolean values saying if the given page is the first
 	* and/or last one of the recordset. Added by Iván Oliva to provide recordset pagination.
 	*
-	* @param secs2cache	seconds to cache data, set to 0 to force query
-	* @param sql
-	* @param nrows		is the number of rows per page to get
-	* @param page		is the page number to get (1-based)
-	* @param [inputarr]	array of bind variables
-	* @return		the recordset ($rs->databaseType == 'array')
+	* @param int $secs2cache	seconds to cache data, set to 0 to force query
+	* @param string $sql
+	* @param int $nrows		is the number of rows per page to get
+	* @param int $page		is the page number to get (1-based)
+	* @param mixed[]|bool $inputarr	array of bind variables
+	* @return mixed	the recordset ($rs->databaseType == 'array')
 	*/
 	function CachePageExecute($secs2cache, $sql, $nrows, $page,$inputarr=false) {
 		/*switch($this->dataProvider) {
@@ -3185,8 +3230,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 			break;
 		default: $secs2cache = 0; break;
 		}*/
-		$rs = $this->PageExecute($sql,$nrows,$page,$inputarr,$secs2cache);
-		return $rs;
+		return $this->PageExecute($sql,$nrows,$page,$inputarr,$secs2cache);
 	}
 
 	/**
@@ -3195,8 +3239,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	*
 	* @return int
 	*/
-	function charMax()
-	{
+	function charMax() {
 		return ADODB_STRINGMAX_NOTSET;
 	}
 
@@ -3206,8 +3249,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	*
 	* @return int
 	*/
-	function textMax()
-	{
+	function textMax() {
 		return ADODB_STRINGMAX_NOTSET;
 	}
 
@@ -3221,7 +3263,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	* @param	int		$start	The start point
 	* @param	int		$length	An optional length
 	*
-	* @return	The SQL text
+	* @return string	The SQL text
 	*/
 	function substr($fld,$start,$length=0) {
 		$text = "{$this->substr}($fld,$start";
@@ -3239,9 +3281,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * @return	string				The SQL text
 	 */
 	function month($fld) {
-		$x = $this->sqlDate('m',$fld);
-
-		return $x;
+		return $this->sqlDate('m',$fld);
 	}
 
 	/*
@@ -3251,8 +3291,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * @return	string		The SQL text
 	 */
 	function day($fld) {
-		$x = $this->sqlDate('d',$fld);
-		return $x;
+		return $this->sqlDate('d',$fld);
 	}
 
 	/*
@@ -3263,8 +3302,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * @return	string		The SQL text
 	 */
 	function year($fld) {
-		$x = $this->sqlDate('Y',$fld);
-		return $x;
+		return $this->sqlDate('Y',$fld);
 	}
 
 	/**
@@ -3273,7 +3311,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * By clearing the message, it becomes possible to detect whether a new error
 	 * has occurred, even when it is the same error as before being repeated.
 	 *
-	 * @return array|null Array if an error has previously occurred. Null otherwise.
+	 * @return mixed[]|null Array if an error has previously occurred. Null otherwise.
 	 */
 	protected function resetLastError() {
 		$error = error_get_last();
@@ -3289,7 +3327,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * Compare a previously stored error message with the last error recorded by PHP
 	 * to determine whether a new error has occurred.
 	 *
-	 * @param array|null $old Optional. Previously stored return value of error_get_last().
+	 * @param mixed[]|null $old Optional. Previously stored return value of error_get_last().
 	 *
 	 * @return string The error message if a new error has occurred
 	 *                or an empty string if no (new) errors have occurred..
@@ -3556,7 +3594,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	/**
 	 * Constructor
 	 *
-	 * @param queryID	this is the queryID returned by ADOConnection->_query()
+	 * @param resource|int queryID	this is the queryID returned by ADOConnection->_query()
 	 *
 	 */
 	function __construct($queryID) {
@@ -3733,8 +3771,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	}
 
 	function GetAll($nRows = -1) {
-		$arr = $this->GetArray($nRows);
-		return $arr;
+		return $this->GetArray($nRows);
 	}
 
 	/*
@@ -3752,12 +3789,11 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * @param offset	is 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
+	 * @return array an array indexed by the rows (0-based) from the recordset
 	 */
 	function GetArrayLimit($nrows,$offset=-1) {
 		if ($offset <= 0) {
-			$arr = $this->GetArray($nrows);
-			return $arr;
+			return $this->GetArray($nrows);
 		}
 
 		$this->Move($offset);
@@ -3778,11 +3814,10 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 *
 	 * @param [nRows]  is the number of rows to return. -1 means every row.
 	 *
-	 * @return an array indexed by the rows (0-based) from the recordset
+	 * @return array an array indexed by the rows (0-based) from the recordset
 	 */
 	function GetRows($nRows = -1) {
-		$arr = $this->GetArray($nRows);
-		return $arr;
+		return $this->GetArray($nRows);
 	}
 
 	/**
@@ -3806,12 +3841,11 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 *								array[col0] => array(remaining cols),
 	 *								return array[col0] => col1
 	 *
-	 * @return mixed
+	 * @return mixed[]|false
 	 *
 	 */
 	function getAssoc($force_array = false, $first2cols = false)
 	{
-		
 		global $ADODB_FETCH_MODE;
 		/*
 		* Insufficient rows to show data
@@ -3864,8 +3898,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 			$myFields = $this->fields;
 
-			if ($fetchMode == ADODB_FETCH_BOTH)
-			{
+			if ($fetchMode == ADODB_FETCH_BOTH) {
 				/*
 				* extract the associative keys
 				*/
@@ -3877,13 +3910,11 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 			* The key is not case processed
 			*/
 			$key = array_shift($myFields);
-			
-			switch ($showArrayMethod)
-			{
+
+			switch ($showArrayMethod) {
 			case 0:
 
-				if ($fetchMode == ADODB_FETCH_ASSOC)
-				{
+				if ($fetchMode == ADODB_FETCH_ASSOC) {
 					/*
 					* The driver should have already handled the key
 					* casing, but in case it did not. We will check and force
@@ -3931,10 +3962,10 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 	/**
 	 *
-	 * @param v		is the character timestamp in YYYY-MM-DD hh:mm:ss format
-	 * @param fmt	is the format to apply to it, using date()
+	 * @param mixed $v		is the character timestamp in YYYY-MM-DD hh:mm:ss format
+	 * @param string [$fmt]	is the format to apply to it, using date()
 	 *
-	 * @return a timestamp formatted as user desires
+	 * @return string a timestamp formated as user desires
 	 */
 	function UserTimeStamp($v,$fmt='Y-m-d H:i:s') {
 		if (is_numeric($v) && strlen($v)<14) {
@@ -3953,10 +3984,10 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 
 	/**
-	 * @param v		is the character date in YYYY-MM-DD format, returned by database
-	 * @param fmt	is the format to apply to it, using date()
+	 * @param mixed $v		is the character date in YYYY-MM-DD format, returned by database
+	 * @param string $fmt	is the format to apply to it, using date()
 	 *
-	 * @return a date formatted as user desires
+	 * @return string a date formatted as user desires
 	 */
 	function UserDate($v,$fmt='Y-m-d') {
 		$tt = $this->UnixDate($v);
@@ -3973,9 +4004,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 
 	/**
-	 * @param $v is a date string in YYYY-MM-DD format
+	 * @param mixed $v is a date string in YYYY-MM-DD format
 	 *
-	 * @return date in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format
+	 * @return string date in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format
 	 */
 	static function UnixDate($v) {
 		return ADOConnection::UnixDate($v);
@@ -3983,9 +4014,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 
 	/**
-	 * @param $v is a timestamp string in YYYY-MM-DD HH-NN-SS format
+	 * @param string|object $v is a timestamp string in YYYY-MM-DD HH-NN-SS format
 	 *
-	 * @return date in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format
+	 * @return mixed date in unix timestamp format, or 0 if before TIMESTAMP_FIRST_YEAR, or false if invalid date format
 	 */
 	static function UnixTimeStamp($v) {
 		return ADOConnection::UnixTimeStamp($v);
@@ -4001,26 +4032,30 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 
 
 	/**
-	* PEAR DB compat, number of rows
-	*/
+	 * PEAR DB compat, number of rows
+	 *
+	 * @return int
+	 */
 	function NumRows() {
 		return $this->_numOfRows;
 	}
 
 
 	/**
-	* PEAR DB compat, number of cols
-	*/
+	 * PEAR DB compat, number of cols
+	 *
+	 * @return int
+	 */
 	function NumCols() {
 		return $this->_numOfFields;
 	}
 
 	/**
-	* Fetch a row, returning false if no more rows.
-	* This is PEAR DB compat mode.
-	*
-	* @return false or array containing the current record
-	*/
+	 * Fetch a row, returning false if no more rows.
+	 * This is PEAR DB compat mode.
+	 *
+	 * @return mixed[]|false false or array containing the current record
+	 */
 	function FetchRow() {
 		if ($this->EOF) {
 			return false;
@@ -4038,7 +4073,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	* Fetch a row, returning PEAR_Error if no more rows.
 	* This is PEAR DB compat mode.
 	*
-	* @return DB_OK or error object
+	* @param mixed[]|false $arr
+	*
+	* @return mixed DB_OK or error object
 	*/
 	function FetchInto(&$arr) {
 		if ($this->EOF) {
@@ -4053,7 +4090,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	/**
 	 * Move to the first row in the recordset. Many databases do NOT support this.
 	 *
-	 * @return true or false
+	 * @return bool true or false
 	 */
 	function MoveFirst() {
 		if ($this->_currentRow == 0) {
@@ -4066,7 +4103,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	/**
 	 * Move to the last row in the recordset.
 	 *
-	 * @return true or false
+	 * @return bool true or false
 	 */
 	function MoveLast() {
 		if ($this->_numOfRows >= 0) {
@@ -4088,7 +4125,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	/**
 	 * Move to next record in the recordset.
 	 *
-	 * @return true if there still rows available, or false if there are no more rows (EOF).
+	 * @return bool true if there still rows available, or false if there are no more rows (EOF).
 	 */
 	function MoveNext() {
 		if (!$this->EOF) {
@@ -4113,9 +4150,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * 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 int $rowNumber is the row to move to (0-based)
 	 *
-	 * @return true if there still rows available, or false if there are no more rows (EOF).
+	 * @return bool true if there still rows available, or false if there are no more rows (EOF).
 	 */
 	function Move($rowNumber = 0) {
 		$this->EOF = false;
@@ -4167,9 +4204,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * Get the value of a field in the current row by column name.
 	 * Will not work if ADODB_FETCH_MODE is set to ADODB_FETCH_NUM.
 	 *
-	 * @param colname  is the field to access
+	 * @param string $colname is the field to access
 	 *
-	 * @return the value of $colname column
+	 * @return mixed the value of $colname column
 	 */
 	function Fields($colname) {
 		return $this->fields[$colname];
@@ -4178,6 +4215,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	/**
 	 * Defines the function to use for table fields case conversion
 	 * depending on ADODB_ASSOC_CASE
+	 *
+	 * @param int [$case]
+	 *
 	 * @return string strtolower/strtoupper or false if no conversion needed
 	 */
 	protected function AssocCaseConvertFunction($case = ADODB_ASSOC_CASE) {
@@ -4195,7 +4235,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	/**
 	 * Builds the bind array associating keys to recordset fields
 	 *
-	 * @param int $upper Case for the array keys, defaults to uppercase
+	 * @param int [$upper] Case for the array keys, defaults to uppercase
 	 *                   (see ADODB_ASSOC_CASE_xxx constants)
 	 */
 	function GetAssocKeys($upper = ADODB_ASSOC_CASE) {
@@ -4232,7 +4272,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	 * Use associative array to get fields array for databases that do not support
 	 * associative arrays. Submitted by Paolo S. Asioli paolo.asioli#libero.it
 	 *
-	 * @param int $upper Case for the array keys, defaults to uppercase
+	 * @param int [$upper] Case for the array keys, defaults to uppercase
 	 *                   (see ADODB_ASSOC_CASE_xxx constants)
 	 */
 	function GetRowAssoc($upper = ADODB_ASSOC_CASE) {
@@ -4255,7 +4295,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	/**
 	 * Clean up recordset
 	 *
-	 * @return true or false
+	 * @return bool
 	 */
 	function Close() {
 		// free connection object - this seems to globally free the object
@@ -4269,19 +4309,21 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	}
 
 	/**
-	 * synonyms RecordCount and RowCount
+	 * Synonyms RecordCount and RowCount
 	 *
-	 * @return the number of rows or -1 if this is not supported
+	 * @return int Number of rows or -1 if this is not supported
 	 */
 	function RecordCount() {
 		return $this->_numOfRows;
 	}
 
 
-	/*
-	* If we are using PageExecute(), this will return the maximum possible rows
-	* that can be returned when paging a recordset.
-	*/
+	/**
+	 * If we are using PageExecute(), this will return the maximum possible rows
+	 * that can be returned when paging a recordset.
+	 *
+	 * @return int
+	 */
 	function MaxRecordCount() {
 		return ($this->_maxRecordCount) ? $this->_maxRecordCount : $this->RecordCount();
 	}
@@ -4347,7 +4389,6 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 		return $this->_numOfFields;
 	}
 
-
 	/**
 	 * Get the ADOFieldObject of a specific column.
 	 *
@@ -4382,8 +4423,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	* @return the object with the properties set to the fields of the current row
 	*/
 	function FetchObj() {
-		$o = $this->FetchObject(false);
-		return $o;
+		return $this->FetchObject(false);
 	}
 
 	/**
@@ -4433,8 +4473,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	* Fixed bug reported by tim@orotech.net
 	*/
 	function FetchNextObj() {
-		$o = $this->FetchNextObject(false);
-		return $o;
+		return $this->FetchNextObject(false);
 	}
 
 
@@ -4793,7 +4832,7 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 		 *			unless parameter $colnames is used.
 		 * @param typearr	holds an array of types. These are the same types
 		 *			used in MetaTypes (C,B,L,I,N).
-		 * @param [colnames]	array of column names. If set, then the first row of
+		 * @param string[]|false [$colnames]	array of column names. If set, then the first row of
 		 *			$array should not hold the column names.
 		 */
 		function InitArray($array,$typearr,$colnames=false) {
@@ -4811,10 +4850,10 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 		/**
 		 * Setup the Array and datatype file objects
 		 *
-		 * @param array		is a 2-dimensional array holding the data.
+		 * @param array $array    2-dimensional array holding the data
 		 *			The first row should hold the column names
 		 *			unless parameter $colnames is used.
-		 * @param fieldarr	holds an array of ADOFieldObject's.
+		 * @param array $fieldarr Array of ADOFieldObject's.
 		 */
 		function InitArrayFields(&$array,&$fieldarr) {
 			$this->_array = $array;
@@ -4825,12 +4864,15 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 			$this->Init();
 		}
 
+		/**
+		 * @param int [$nRows]
+		 * @return array
+		 */
 		function GetArray($nRows=-1) {
 			if ($nRows == -1 && $this->_currentRow <= 0 && !$this->_skiprow1) {
 				return $this->_array;
 			} else {
-				$arr = ADORecordSet::GetArray($nRows);
-				return $arr;
+				return ADORecordSet::GetArray($nRows);
 			}
 		}
 
@@ -4845,7 +4887,12 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 				: sizeof($this->_types);
 		}
 
-		/* Use associative array to get fields array */
+		/**
+		 * Use associative array to get fields array
+		 *
+		 * @param string $colname
+		 * @return mixed
+		 */
 		function Fields($colname) {
 			$mode = isset($this->adodbFetchMode) ? $this->adodbFetchMode : $this->fetchMode;
 
@@ -4865,6 +4912,11 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 			return $this->fields[$this->bind[strtoupper($colname)]];
 		}
 
+		/**
+		 * @param int [$fieldOffset]
+		 *
+		 * @return \ADOFieldObject
+		 */
 		function FetchField($fieldOffset = -1) {
 			if (isset($this->_fieldobjects)) {
 				return $this->_fieldobjects[$fieldOffset];
@@ -4877,6 +4929,10 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 			return $o;
 		}
 
+		/**
+		 * @param int $row
+		 * @return bool
+		 */
 		function _seek($row) {
 			if (sizeof($this->_array) && 0 <= $row && $row < $this->_numOfRows) {
 				$this->_currentRow = $row;
@@ -4889,6 +4945,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 			return false;
 		}
 
+		/**
+		 * @return bool
+		 */
 		function MoveNext() {
 			if (!$this->EOF) {
 				$this->_currentRow++;
@@ -4912,6 +4971,9 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 			return false;
 		}
 
+		/**
+		 * @return bool
+		 */
 		function _fetch() {
 			$pos = $this->_currentRow;
 
@@ -5011,17 +5073,20 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 	}
 
 	/**
-	 * synonym for ADONewConnection for people like me who cannot remember the correct name
+	 * Synonym for ADONewConnection for people like me who cannot remember the correct name
+	 *
+	 * @param string [$db]
+	 *
+	 * @return ADOConnection|false
 	 */
 	function NewADOConnection($db='') {
-		$tmp = ADONewConnection($db);
-		return $tmp;
+		return ADONewConnection($db);
 	}
 
 	/**
 	 * Instantiate a new Connection class for a specific database driver.
 	 *
-	 * @param [db]  is the database Connection object to create. If undefined,
+	 * @param string $db Database Connection object to create. If undefined,
 	 *	use the last database driver that was loaded by ADOLoadCode().
 	 *
 	 * @return ADOConnection|false The freshly created instance of the Connection class
@@ -5280,9 +5345,8 @@ http://www.stanford.edu/dept/itss/docs/oracle/10g/server.101/b10759/statements_1
 		if (!class_exists($class)) {
 			return false;
 		}
-		$perf = new $class($conn);
 
-		return $perf;
+		return new $class($conn);
 	}
 
 	function NewDataDictionary(&$conn,$drivername=false) {