Home » Database » MDB2 » Bug #10216

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

Description:
------------
Improvements to docblocks - added missing @param for a method, and "improved" English to make more readable.

Test script:
---------------
--- MDB2/Driver/Datatype/Common.php (revision 4728)
+++ MDB2/Driver/Datatype/Common.php (working copy)
@@ -159,11 +159,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
- * @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)
@@ -218,11 +219,11 @@
// {{{ convertResult()

/**
- * convert a value to a RDBMS indepdenant MDB2 type
+ * Convert a value to a RDBMS indepdenant MDB2 type
*
* @param mixed $value value to be converted
* @param string $type specifies which type to convert to
- * @param bool $rtrim if to rtrim text values or not
+ * @param bool $rtrim optional value, when true, rtrim text values
* @return mixed converted value
* @access public
*/
@@ -249,12 +250,12 @@
// {{{ convertResultRow()

/**
- * convert a result row
+ * Convert a result row
*
* @param array $types
* @param array $row specifies the types to convert to
- * @param bool $rtrim if to rtrim text values or not
- * @return mixed MDB2_OK on success, a MDB2 error on failure
+ * @param bool $rtrim optional value, when true, rtrim text values
+ * @return mixed MDB2_OK on success, an MDB2 error on failure
* @access public
*/
function convertResultRow($types, $row, $rtrim = true)