Bug #10217

Improvements to API documentation

Details

Doc Bug #10217	Improvements to API documentation
Submitted	2007-02-28 11:18 UTC
From	andrew dot hill at openads dot org
Assigned	quipo
Status	Closed
Package	MDB2_Driver_pgsql
PHP Version	4.3.11
OS	Centos 4.3, Apache 1.3
Roadmaps	(Not assigned)

Comments

[2007-02-28 11:18 UTC] andrew dot hill at openads dot org

Description:
------------
Improvement to documentation to make consistant with changes suggested in http://pear.php.net/bugs/bug.php?id=10216.

Test script:
---------------
--- MDB2/Driver/Datatype/pgsql.php (revision 4728)
+++ MDB2/Driver/Datatype/pgsql.php (working copy)
@@ -58,12 +58,12 @@
// {{{ _baseConvertResult()

/**
- * general type conversion method
+ * General type conversion method
*
* @param mixed $value refernce to a value to be converted
* @param string $type specifies which type to convert to
- * @param string $rtrim if text should be rtrimmed
- * @return object a MDB2 error on failure
+ * @param bool $rtrim optional value, when true, rtrim text values
+ * @return object an MDB2 error on failure
* @access protected
*/
function _baseConvertResult($value, $type, $rtrim = true)