MDL-30972 Documentation : improved @see as well as added appropriate uses of inline @link.

This commit is contained in:
Aparup Banerjee
2012-02-16 10:29:45 +08:00
parent 096880eb7c
commit dafa20e85c
8 changed files with 47 additions and 34 deletions
+4 -2
View File
@@ -613,7 +613,8 @@ class pgsql_native_moodle_database extends moodle_database {
* code where it's possible there might be large datasets being returned. For known
* small datasets use get_records_sql - it leads to simpler code.
*
* The return type is as for @see function get_recordset.
* The return type is like:
* @see function get_recordset.
*
* @param string $sql the SQL select query to execute.
* @param array $params array of sql parameters
@@ -653,7 +654,8 @@ class pgsql_native_moodle_database extends moodle_database {
/**
* Get a number of records as an array of objects using a SQL statement.
*
* Return value as for @see function get_records.
* Return value is like:
* @see function get_records.
*
* @param string $sql the SQL select query to execute. The first column of this SELECT statement
* must be a unique value (usually the 'id' field), as it will be used as the key of the