Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

MDL-30972 More phpdocs changes after Jenkins review.

  • Loading branch information...
commit 096880eb7c478a30e6a450163cbb69051130e6af 1 parent a0eb2e9
@nebgor nebgor authored
View
21 lib/dml/moodle_database.php
@@ -125,9 +125,15 @@
/** @var bool Flag used to force rollback of all current transactions. */
private $force_rollback = false;
- /** @var int internal temporary variable used to fix params. {@see _fix_sql_params_dollar_callback()} */
+ /**
+ * @var int internal temporary variable used to fix params.
+ * @see _fix_sql_params_dollar_callback()
+ */
private $fix_sql_params_i;
- /** @var int internal temporary variable used to guarantee unique parameters in each request. {@see get_in_or_equal()} */
+ /**
+ * @var int internal temporary variable used to guarantee unique parameters in each request.
+ * @see get_in_or_equal()
+ */
private $inorequaluniqueindex = 1;
/**
@@ -297,6 +303,7 @@ protected function store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, a
* @param string $dbuser The database user to connect as.
* @param string $dbpass The password to use when connecting to the database.
* @param string $dbname The name of the database being connected to.
+ * @param array $dboptions An array of optional database options (eg: dbport)
*
* @return bool success True for successful connection. False otherwise.
*/
@@ -374,7 +381,7 @@ protected function query_start($sql, array $params=null, $type, $extrainfo=null)
/**
* This should be called immediately after each db query. It does a clean up of resources.
* It also throws exceptions if the sql that ran produced errors.
- * @param mixed The db specific result obtained from running a query.
+ * @param mixed $result The db specific result obtained from running a query.
* @throws dml_read_exception | dml_write_exception | ddl_change_structure_exception
* @return void
*/
@@ -678,7 +685,8 @@ protected function fix_table_names($sql) {
/**
* Internal private utitlity function used to fix parameters.
* Used with preg_replace_callback()
- * @param $match
+ * @param array $match Refer to preg_replace_callback usage for description.
+ * @see preg_replace_callback()
*/
private function _fix_sql_params_dollar_callback($match) {
$this->fix_sql_params_i++;
@@ -1866,9 +1874,8 @@ public function sql_ilike() {
* This function accepts variable number of string parameters.
* All strings/fieldnames will used in the SQL concatenate statement generated.
*
- * @return string The SQL to concatenate strings.
- * @param mixed $fieldnames,... unlimited OPTIONAL number of additional field names.
- * @uses func_get_args()
+ * @return string The SQL to concatenate strings passed in.
+ * @uses func_get_args() and thus parameters are unlimited OPTIONAL number of additional field names.
*/
public abstract function sql_concat();
View
2  lib/dml/moodle_temptables.php
@@ -55,7 +55,7 @@ class moodle_temptables {
/**
* Creates new moodle_temptables instance
- * @param moodle_database An instance of moodle_database.
+ * @param moodle_database $mdb An instance of moodle_database.
*/
public function __construct($mdb) {
$this->mdb = $mdb;
View
4 lib/dmllib.php
@@ -83,7 +83,7 @@ function __construct($errorcode, $a=NULL, $debuginfo=null) {
class dml_connection_exception extends dml_exception {
/**
* Constructor
- * @param string $errorinfo Optional debugging information.
+ * @param string $error Optional debugging information.
*/
function __construct($error) {
$errorinfo = $error;
@@ -186,7 +186,7 @@ class dml_missing_record_exception extends dml_exception {
/**
* Constructor
- * @param string $table The table name if known, '' if unknown.
+ * @param string $tablename The table name if known, '' if unknown.
* @param string $sql Optional SQL query.
* @param array $params Optional SQL query's parameters.
*/
Please sign in to comment.
Something went wrong with that request. Please try again.