From: samhemelryk <samhemelryk>
Date: Fri, 22 May 2009 09:10:53 +0000 (+0000)
Subject: deprecatedlib MDL-19236 corrected boilerplate tag order and package
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=c861fe2f831e632b350d9687cf4ef5ded5678554;p=moodle.git

deprecatedlib MDL-19236 corrected boilerplate tag order and package
---

diff --git a/lib/deprecatedlib.php b/lib/deprecatedlib.php
index 3969249839..3657be8163 100644
--- a/lib/deprecatedlib.php
+++ b/lib/deprecatedlib.php
@@ -1,27 +1,19 @@
-<?php // $Id$
-
-///////////////////////////////////////////////////////////////////////////
-//                                                                       //
-// NOTICE OF COPYRIGHT                                                   //
-//                                                                       //
-// Moodle - Modular Object-Oriented Dynamic Learning Environment         //
-//          http://moodle.org                                            //
-//                                                                       //
-// Copyright (C) 1999 onwards Martin Dougiamas, Moodle  http://moodle.com//
-//                                                                       //
-// This program is free software; you can redistribute it and/or modify  //
-// it under the terms of the GNU General Public License as published by  //
-// the Free Software Foundation; either version 2 of the License, or     //
-// (at your option) any later version.                                   //
-//                                                                       //
-// This program is distributed in the hope that it will be useful,       //
-// but WITHOUT ANY WARRANTY; without even the implied warranty of        //
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
-// GNU General Public License for more details:                          //
-//                                                                       //
-//          http://www.gnu.org/copyleft/gpl.html                         //
-//                                                                       //
-///////////////////////////////////////////////////////////////////////////
+<?php
+
+// This file is part of Moodle - http://moodle.org/ 
+// 
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
  * deprecatedlib.php - Old functions retained only for backward compatibility
@@ -29,22 +21,24 @@
  * Old functions retained only for backward compatibility.  New code should not
  * use any of these functions.
  *
- * @author Martin Dougiamas
- * @version $Id$
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  * @package moodlecore
+ * @subpackage deprecated
+ * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @deprecated
  */
 
 /**
  * Determines if a user is a teacher (or better)
  *
- * @uses $CFG
+ * @global object
+ * @uses CONTEXT_COURSE
+ * @uses CONTEXT_SYSTEM
  * @param int $courseid The id of the course that is being viewed, if any
  * @param int $userid The id of the user that is being tested against. Set this to 0 if you would just like to test against the currently logged in user.
  * @param bool $obsolete_includeadmin Not used any more
  * @return bool
  */
-
 function isteacher($courseid=0, $userid=0, $obsolete_includeadmin=true) {
 /// Is the user able to access this course as a teacher?
     global $CFG;
@@ -63,7 +57,11 @@ function isteacher($courseid=0, $userid=0, $obsolete_includeadmin=true) {
 /**
  * Determines if a user is a teacher in any course, or an admin
  *
- * @uses $USER
+ * @global object
+ * @global object
+ * @global object
+ * @uses CAP_ALLOW
+ * @uses CONTEXT_SYSTEM
  * @param int $userid The id of the user that is being tested against. Set this to 0 if you would just like to test against the currently logged in user.
  * @param bool $includeadmin Include anyone wo is an admin as well
  * @return bool
@@ -115,6 +113,8 @@ function isteacherinanycourse($userid=0, $includeadmin=true) {
 /**
  * Determines if the specified user is logged in as guest.
  *
+ * @global object
+ * @uses CONTEXT_SYSTEM
  * @param int $userid The user being tested. You can set this to 0 or leave it blank to test the currently logged in user.
  * @return bool
  */
@@ -130,8 +130,10 @@ function isguest($userid=0) {
 /**
  * Get the guest user information from the database
  *
+ * @todo Is object(user) a correct return type? Or is array the proper return type with a 
+ * note that the contents include all details for a user.
+ *
  * @return object(user) An associative array with the details of the guest user account.
- * @todo Is object(user) a correct return type? Or is array the proper return type with a note that the contents include all details for a user.
  */
 function get_guest() {
     return get_complete_user_data('username', 'guest');
@@ -140,10 +142,10 @@ function get_guest() {
 /**
  * Returns $user object of the main teacher for a course
  *
- * @uses $CFG
+ * @global object
+ * @uses CONTEXT_COURSE
  * @param int $courseid The course in question.
  * @return user|false  A {@link $USER} record of the main teacher for the specified course or false if error.
- * @todo Finish documenting this function
  */
 function get_teacher($courseid) {
 
@@ -166,10 +168,11 @@ function get_teacher($courseid) {
  *
  * used to print recent activity
  *
- * @uses $CFG
+ * @global object
+ * @uses CONTEXT_COURSE
  * @param int $courseid The course in question.
+ * @param int $timestart The date to check forward of
  * @return object|false  {@link $USER} records or false if error.
- * @todo Finish documenting this function
  */
 function get_recent_enrolments($courseid, $timestart) {
     global $DB;
@@ -199,13 +202,15 @@ function get_recent_enrolments($courseid, $timestart) {
  * parameters remain.  If possible, $align, $width and $color should not be defined at all.
  * Preferably just use print_box() in weblib.php
  *
- * @param string $align, alignment of the box, not the text (default center, left, right).
- * @param string $width, width of the box, including units %, for example '100%'.
- * @param string $color, background colour of the box, for example '#eee'.
- * @param int $padding, padding in pixels, specified without units.
- * @param string $class, space-separated class names.
- * @param string $id, space-separated id names.
- * @param boolean $return, return as string or just print it
+ * @param string $message The message to display
+ * @param string $align alignment of the box, not the text (default center, left, right).
+ * @param string $width width of the box, including units %, for example '100%'.
+ * @param string $color background colour of the box, for example '#eee'.
+ * @param int $padding padding in pixels, specified without units.
+ * @param string $class space-separated class names.
+ * @param string $id space-separated id names.
+ * @param boolean $return return as string or just print it
+ * @return string|void Depending on $return
  */
 function print_simple_box($message, $align='', $width='', $color='', $padding=5, $class='generalbox', $id='', $return=false) {
     $output = '';
@@ -227,13 +232,14 @@ function print_simple_box($message, $align='', $width='', $color='', $padding=5,
  * parameters remain.  If possible, $align, $width and $color should not be defined at all.
  * Even better, please use print_box_start() in weblib.php
  *
- * @param string $align, alignment of the box, not the text (default center, left, right).   DEPRECATED
- * @param string $width, width of the box, including % units, for example '100%'.            DEPRECATED
- * @param string $color, background colour of the box, for example '#eee'.                   DEPRECATED
- * @param int $padding, padding in pixels, specified without units.                          OBSOLETE
- * @param string $class, space-separated class names.
- * @param string $id, space-separated id names.
- * @param boolean $return, return as string or just print it
+ * @param string $align alignment of the box, not the text (default center, left, right).   DEPRECATED
+ * @param string $width width of the box, including % units, for example '100%'.            DEPRECATED
+ * @param string $color background colour of the box, for example '#eee'.                   DEPRECATED
+ * @param int $padding padding in pixels, specified without units.                          OBSOLETE
+ * @param string $class space-separated class names.
+ * @param string $id space-separated id names.
+ * @param boolean $return return as string or just print it
+ * @return string|void Depending on $return
  */
 function print_simple_box_start($align='', $width='', $color='', $padding=5, $class='generalbox', $id='', $return=false) {
 
@@ -283,6 +289,9 @@ function print_simple_box_start($align='', $width='', $color='', $padding=5, $cl
 /**
  * Print the end portion of a standard themed box.
  * Preferably just use print_box_end() in weblib.php
+ *
+ * @param boolean $return return as string or just print it
+ * @return string|void Depending on $return
  */
 function print_simple_box_end($return=false) {
     $output = '</div>';
@@ -297,9 +306,11 @@ function print_simple_box_end($return=false) {
  * deprecated - use clean_param($string, PARAM_FILE); instead
  * Check for bad characters ?
  *
+ * @todo Finish documenting this function - more detail needed in description as well as details on arguments
+ *
  * @param string $string ?
  * @param int $allowdots ?
- * @todo Finish documenting this function - more detail needed in description as well as details on arguments
+ * @return bool
  */
 function detect_munged_arguments($string, $allowdots=1) {
     if (substr_count($string, '..') > $allowdots) {   // Sometimes we allow dots in references
@@ -321,6 +332,11 @@ function detect_munged_arguments($string, $allowdots=1) {
  * Both parameters must be FULL paths
  * If destination isn't specified, it will be the
  * SAME directory where the zip file resides.
+ *
+ * @global object
+ * @param string $zipfile The zip file to unzip
+ * @param string $destination The location to unzip to
+ * @param bool $showstatus_ignored Unused
  */
 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
     global $CFG;
@@ -382,6 +398,11 @@ function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
 /**
  * Zip an array of files/dirs to a destination zip file
  * Both parameters must be FULL paths to the files/dirs
+ *
+ * @global object
+ * @param array $originalfiles Files to zip
+ * @param string $destination The destination path
+ * @return bool Outcome
  */
 function zip_files ($originalfiles, $destination) {
     global $CFG;
@@ -458,9 +479,9 @@ function zip_files ($originalfiles, $destination) {
 /**
  * Get the IDs for the user's groups in the given course.
  *
- * @uses $USER
+ * @global object
  * @param int $courseid The course being examined - the 'course' table id field.
- * @return array An _array_ of groupids.
+ * @return array|bool An _array_ of groupids, or false
  * (Was return $groupids[0] - consequences!)
  */
 function mygroupid($courseid) {
@@ -477,6 +498,10 @@ function mygroupid($courseid) {
  * Returns the current group mode for a given course or activity module
  *
  * Could be false, SEPARATEGROUPS or VISIBLEGROUPS    (<-- Martin)
+ *
+ * @param object $course Course Object
+ * @param object $cm Course Manager Object
+ * @return mixed $course->groupmode
  */
 function groupmode($course, $cm=null) {
 
@@ -491,7 +516,8 @@ function groupmode($course, $cm=null) {
  * When $SESSION->currentgroup[$courseid] is set to 0 it means, show all groups.
  * Sets currentgroup[$courseid] in the session variable appropriately.
  * Does not do any permission checking.
- * @uses $SESSION
+ *
+ * @global object
  * @param int $courseid The course being examined - relates to id field in
  * 'course' table.
  * @param int $groupid The group being examined.
@@ -506,12 +532,12 @@ function set_current_group($courseid, $groupid) {
 /**
  * Gets the current group - either from the session variable or from the database.
  *
- * @uses $USER
- * @uses $SESSION
+ * @global object
  * @param int $courseid The course being examined - relates to id field in
  * 'course' table.
  * @param bool $full If true, the return value is a full record object.
  * If false, just the id of the record.
+ * @return int|bool
  */
 function get_current_group($courseid, $full = false) {
     global $SESSION;
@@ -547,9 +573,10 @@ function get_current_group($courseid, $full = false) {
  * Print an error page displaying an error message.
  * Old method, don't call directly in new code - use print_error instead.
  *
+ * @global object
  * @param string $message The message to display to the user about the error.
  * @param string $link The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page.
- * @return terminates script, does not return!
+ * @return void Terminates script, does not return!
  */
 function error($message, $link='') {
     global $UNITTEST;
@@ -566,55 +593,111 @@ function error($message, $link='') {
 
 
 /// Deprecated DDL functions, to be removed soon ///
-
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @return bool
+ */
 function table_exists($table) {
     global $DB;
     debugging('Deprecated ddllib function used!');
     return $DB->get_manager()->table_exists($table);
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function field_exists($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
     return $DB->get_manager()->field_exists($table, $field);
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $index
+ * @return bool
+ */
 function find_index_name($table, $index) {
     global $DB;
     debugging('Deprecated ddllib function used!');
     return $DB->get_manager()->find_index_name($table, $index);
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $index
+ * @return bool
+ */
 function index_exists($table, $index) {
     global $DB;
     debugging('Deprecated ddllib function used!');
     return $DB->get_manager()->index_exists($table, $index);
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function find_check_constraint_name($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
     return $DB->get_manager()->find_check_constraint_name($table, $field);
 }
 
+/**
+ * @deprecated
+ * @global object
+ */
 function check_constraint_exists($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
     return $DB->get_manager()->check_constraint_exists($table, $field);
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $xmldb_key
+ * @return bool
+ */
 function find_key_name($table, $xmldb_key) {
     global $DB;
     debugging('Deprecated ddllib function used!');
     return $DB->get_manager()->find_key_name($table, $xmldb_key);
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @return bool
+ */
 function find_sequence_name($table) {
     global $DB;
     debugging('Deprecated ddllib function used!');
     return $DB->get_manager()->find_sequence_name($table);
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @return bool
+ */
 function drop_table($table) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -622,6 +705,12 @@ function drop_table($table) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $file
+ * @return bool
+ */
 function install_from_xmldb_file($file) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -629,6 +718,12 @@ function install_from_xmldb_file($file) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @return bool
+ */
 function create_table($table) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -636,6 +731,12 @@ function create_table($table) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @return bool
+ */
 function create_temp_table($table) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -643,6 +744,13 @@ function create_temp_table($table) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $newname
+ * @return bool
+ */
 function rename_table($table, $newname) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -650,6 +758,13 @@ function rename_table($table, $newname) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function add_field($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -657,6 +772,13 @@ function add_field($table, $field) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function drop_field($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -664,6 +786,13 @@ function drop_field($table, $field) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function change_field_type($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -671,6 +800,13 @@ function change_field_type($table, $field) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function change_field_precision($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -678,6 +814,13 @@ function change_field_precision($table, $field) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function change_field_unsigned($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -685,6 +828,13 @@ function change_field_unsigned($table, $field) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function change_field_notnull($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -692,6 +842,13 @@ function change_field_notnull($table, $field) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function change_field_enum($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used! Only dropping of enums is allowed.');
@@ -699,6 +856,13 @@ function change_field_enum($table, $field) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @return bool
+ */
 function change_field_default($table, $field) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -706,6 +870,14 @@ function change_field_default($table, $field) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $field
+ * @param string $newname
+ * @return bool
+ */
 function rename_field($table, $field, $newname) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -713,6 +885,13 @@ function rename_field($table, $field, $newname) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $key
+ * @return bool
+ */
 function add_key($table, $key) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -720,6 +899,13 @@ function add_key($table, $key) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $key
+ * @return bool
+ */
 function drop_key($table, $key) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -727,6 +913,14 @@ function drop_key($table, $key) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $key
+ * @param string $newname
+ * @return bool
+ */
 function rename_key($table, $key, $newname) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -734,6 +928,13 @@ function rename_key($table, $key, $newname) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $index
+ * @return bool
+ */
 function add_index($table, $index) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -741,6 +942,13 @@ function add_index($table, $index) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $index
+ * @return bool
+ */
 function drop_index($table, $index) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -748,6 +956,14 @@ function drop_index($table, $index) {
     return true;
 }
 
+/**
+ * @deprecated
+ * @global object
+ * @param string $table
+ * @param string $index
+ * @param string $newname
+ * @return bool
+ */
 function rename_index($table, $index, $newname) {
     global $DB;
     debugging('Deprecated ddllib function used!');
@@ -760,292 +976,711 @@ function rename_index($table, $index, $newname) {
 /// removed functions ////
 //////////////////////////
 
+/**
+ * @deprecated
+ * @param mixed $mixed
+ * @return void Throws an error and does nothing
+ */
 function stripslashes_safe($mixed) {
     error('stripslashes_safe() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $var
+ * @return void Throws an error and does nothing
+ */
 function stripslashes_recursive($var) {
     error('stripslashes_recursive() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $dataobject
+ * @return void Throws an error and does nothing
+ */
 function addslashes_object($dataobject) {
     error('addslashes_object() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $var
+ * @return void Throws an error and does nothing
+ */
 function addslashes_recursive($var) {
     error('addslashes_recursive() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $command
+ * @param bool $feedback
+ * @return void Throws an error and does nothing
+ */
 function execute_sql($command, $feedback=true) {
     error('execute_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $select
+ * @return void Throws an error and does nothing
+ */
 function record_exists_select($table, $select='') {
     error('record_exists_select() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sql
+ * @return void Throws an error and does nothing
+ */
 function record_exists_sql($sql) {
     error('record_exists_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $select
+ * @param mixed $countitem
+ * @return void Throws an error and does nothing
+ */
 function count_records_select($table, $select='', $countitem='COUNT(*)') {
     error('count_records_select() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sql
+ * @return void Throws an error and does nothing
+ */
 function count_records_sql($sql) {
     error('count_records_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sql
+ * @param bool $expectmultiple
+ * @param bool $nolimit
+ * @return void Throws an error and does nothing
+ */
 function get_record_sql($sql, $expectmultiple=false, $nolimit=false) {
     error('get_record_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $select
+ * @param mixed $fields
+ * @return void Throws an error and does nothing
+ */
 function get_record_select($table, $select='', $fields='*') {
     error('get_record_select() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field
+ * @param mixed $value
+ * @param mixed $sort
+ * @param mixed $fields
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ * @return void Throws an error and does nothing
+ */
 function get_recordset($table, $field='', $value='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
     error('get_recordset() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sql
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ * @return void Throws an error and does nothing
+ */
 function get_recordset_sql($sql, $limitfrom=null, $limitnum=null) {
     error('get_recordset_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $rs
+ * @return void Throws an error and does nothing
+ */
 function rs_fetch_record(&$rs) {
     error('rs_fetch_record() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $rs
+ * @return void Throws an error and does nothing
+ */
 function rs_next_record(&$rs) {
     error('rs_next_record() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $rs
+ * @return void Throws an error and does nothing
+ */
 function rs_fetch_next_record(&$rs) {
     error('rs_fetch_next_record() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $rs
+ * @return void Throws an error and does nothing
+ */
 function rs_EOF($rs) {
     error('rs_EOF() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $rs
+ * @return void Throws an error and does nothing
+ */
 function rs_close(&$rs) {
     error('rs_close() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $select
+ * @param mixed $sort
+ * @param mixed $fields
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ * @return void Throws an error and does nothing
+ */
 function get_records_select($table, $select='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
     error('get_records_select() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $return
+ * @param mixed $select
+ * @return void Throws an error and does nothing
+ */
 function get_field_select($table, $return, $select) {
     error('get_field_select() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sql
+ * @return void Throws an error and does nothing
+ */
 function get_field_sql($sql) {
     error('get_field_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sql
+ * @param mixed $select
+ * @return void Throws an error and does nothing
+ */
 function delete_records_select($table, $select='') {
     error('get_field_sql() not available anymore');
 }
-
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function configure_dbconnection() {
     error('configure_dbconnection() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $field
+ * @return void Throws an error and does nothing
+ */
 function sql_max($field) {
     error('sql_max() removed - use normal sql MAX() instead');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function sql_as() {
     error('sql_as() removed - do not use AS for tables at all');
 }
-
+/**
+ * @deprecated
+ * @param mixed $page
+ * @param mixed $recordsperpage
+ * @return void Throws an error and does nothing
+ */
 function sql_paging_limit($page, $recordsperpage) {
     error('Function sql_paging_limit() is deprecated. Replace it with the correct use of limitfrom, limitnum parameters');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function db_uppercase() {
     error('upper() removed - use normal sql UPPER()');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function db_lowercase() {
     error('upper() removed - use normal sql LOWER()');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sqlfile
+ * @param mixed $sqlstring
+ * @return void Throws an error and does nothing
+ */
 function modify_database($sqlfile='', $sqlstring='') {
     error('modify_database() removed - use new XMLDB functions');
 }
-
+/**
+ * @deprecated
+ * @param mixed $field1
+ * @param mixed $value1
+ * @param mixed $field2
+ * @param mixed $value2
+ * @param mixed $field3
+ * @param mixed $value3
+ * @return void Throws an error and does nothing
+ */
 function where_clause($field1='', $value1='', $field2='', $value2='', $field3='', $value3='') {
     error('where_clause() removed - use new functions with $conditions parameter');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sqlarr
+ * @param mixed $continue
+ * @param mixed $feedback
+ * @return void Throws an error and does nothing
+ */
 function execute_sql_arr($sqlarr, $continue=true, $feedback=true) {
     error('execute_sql_arr() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field
+ * @param mixed $values
+ * @param mixed $sort
+ * @param mixed $fields
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ * @return void Throws an error and does nothing
+ */
 function get_records_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
     error('get_records_list() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field
+ * @param mixed $values
+ * @param mixed $sort
+ * @param mixed $fields
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ * @return void Throws an error and does nothing
+ */
 function get_recordset_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
     error('get_recordset_list() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field
+ * @param mixed $value
+ * @param mixed $sort
+ * @param mixed $fields
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ * @return void Throws an error and does nothing
+ */
 function get_records_menu($table, $field='', $value='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
     error('get_records_menu() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $select
+ * @param mixed $sort
+ * @param mixed $fields
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ * @return void Throws an error and does nothing
+ */
 function get_records_select_menu($table, $select='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
     error('get_records_select_menu() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sql
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ * @return void Throws an error and does nothing
+ */
 function get_records_sql_menu($sql, $limitfrom='', $limitnum='') {
     error('get_records_sql_menu() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $column
+ * @return void Throws an error and does nothing
+ */
 function column_type($table, $column) {
     error('column_type() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $rs
+ * @return void Throws an error and does nothing
+ */
 function recordset_to_menu($rs) {
     error('recordset_to_menu() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $records
+ * @param mixed $field1
+ * @param mixed $field2
+ * @return void Throws an error and does nothing
+ */
 function records_to_menu($records, $field1, $field2) {
     error('records_to_menu() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $newfield
+ * @param mixed $newvalue
+ * @param mixed $select
+ * @param mixed $localcall
+ * @return void Throws an error and does nothing
+ */
 function set_field_select($table, $newfield, $newvalue, $select, $localcall = false) {
     error('set_field_select() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $return
+ * @param mixed $select
+ * @return void Throws an error and does nothing
+ */
 function get_fieldset_select($table, $return, $select) {
     error('get_fieldset_select() removed');
 }
-
+/**
+ * @deprecated
+ * @param mixed $sql
+ * @return void Throws an error and does nothing
+ */
 function get_fieldset_sql($sql) {
     error('get_fieldset_sql() removed');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function sql_ilike() {
     error('sql_ilike() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $first
+ * @param mixed $last
+ * @return void Throws an error and does nothing
+ */
 function sql_fullname($first='firstname', $last='lastname') {
     error('sql_fullname() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function sql_concat() {
     error('sql_concat() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function sql_empty() {
     error('sql_empty() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function sql_substr() {
     error('sql_substr() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $int1
+ * @param mixed $int2
+ * @return void Throws an error and does nothing
+ */
 function sql_bitand($int1, $int2) {
     error('sql_bitand() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $int1
+ * @return void Throws an error and does nothing
+ */
 function sql_bitnot($int1) {
     error('sql_bitnot() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $int1
+ * @param mixed $int2
+ * @return void Throws an error and does nothing
+ */
 function sql_bitor($int1, $int2) {
     error('sql_bitor() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $int1
+ * @param mixed $int2
+ * @return void Throws an error and does nothing
+ */
 function sql_bitxor($int1, $int2) {
     error('sql_bitxor() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $fieldname
+ * @param mixed $text
+ * @return void Throws an error and does nothing
+ */
 function sql_cast_char2int($fieldname, $text=false) {
     error('sql_cast_char2int() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $fieldname
+ * @param mixed $numchars
+ * @return void Throws an error and does nothing
+ */
 function sql_compare_text($fieldname, $numchars=32) {
     error('sql_compare_text() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $fieldname
+ * @param mixed $numchars
+ * @return void Throws an error and does nothing
+ */
 function sql_order_by_text($fieldname, $numchars=32) {
     error('sql_order_by_text() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $fieldname
+ * @return void Throws an error and does nothing
+ */
 function sql_length($fieldname) {
     error('sql_length() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $separator
+ * @param mixed $elements
+ * @return void Throws an error and does nothing
+ */
 function sql_concat_join($separator="' '", $elements=array()) {
     error('sql_concat_join() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $tablename
+ * @param mixed $fieldname
+ * @param mixed $nullablefield
+ * @param mixed $textfield
+ * @return void Throws an error and does nothing
+ */
 function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
     error('sql_isempty() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $tablename
+ * @param mixed $fieldname
+ * @param mixed $nullablefield
+ * @param mixed $textfield
+ * @return void Throws an error and does nothing
+ */
 function sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield) {
     error('sql_isnotempty() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function begin_sql() {
     error('begin_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function commit_sql() {
     error('commit_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @return void Throws an error and does nothing
+ */
 function rollback_sql() {
     error('rollback_sql() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $dataobject
+ * @param mixed $returnid
+ * @param mixed $primarykey
+ * @return void Throws an error and does nothing
+ */
 function insert_record($table, $dataobject, $returnid=true, $primarykey='id') {
     error('insert_record() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $dataobject
+ * @return void Throws an error and does nothing
+ */
 function update_record($table, $dataobject) {
     error('update_record() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field
+ * @param mixed $value
+ * @param mixed $sort
+ * @param mixed $fields
+ * @param mixed $limitfrom
+ * @param mixed $limitnum
+ 
+ * @return void Throws an error and does nothing
+ */
 function get_records($table, $field='', $value='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
     error('get_records() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field1
+ * @param mixed $value1
+ * @param mixed $field2
+ * @param mixed $value2
+ * @param mixed $field3
+ * @param mixed $value3
+ * @param mixed $fields
+ * @return void Throws an error and does nothing
+ */
 function get_record($table, $field1, $value1, $field2='', $value2='', $field3='', $value3='', $fields='*') {
     error('get_record() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $newfield
+ * @param mixed $newvalue
+ * @param mixed $field1
+ * @param mixed $value1
+ * @param mixed $field2
+ * @param mixed $value2
+ * @param mixed $field3
+ * @param mixed $value3
+ * @return void Throws an error and does nothing
+ */
 function set_field($table, $newfield, $newvalue, $field1, $value1, $field2='', $value2='', $field3='', $value3='') {
     error('set_field() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field1
+ * @param mixed $value1
+ * @param mixed $field2
+ * @param mixed $value2
+ * @param mixed $field3
+ * @param mixed $value3
+ * @return void Throws an error and does nothing
+ */
 function count_records($table, $field1='', $value1='', $field2='', $value2='', $field3='', $value3='') {
     error('count_records() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field1
+ * @param mixed $value1
+ * @param mixed $field2
+ * @param mixed $value2
+ * @param mixed $field3
+ * @param mixed $value3
+ * @return void Throws an error and does nothing
+ */
 function record_exists($table, $field1='', $value1='', $field2='', $value2='', $field3='', $value3='') {
     error('record_exists() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $field1
+ * @param mixed $value1
+ * @param mixed $field2
+ * @param mixed $value2
+ * @param mixed $field3
+ * @param mixed $value3
+ * @return void Throws an error and does nothing
+ */
 function delete_records($table, $field1='', $value1='', $field2='', $value2='', $field3='', $value3='') {
     error('delete_records() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $return
+ * @param mixed $field1
+ * @param mixed $value1
+ * @param mixed $field2
+ * @param mixed $value2
+ * @param mixed $field3
+ * @param mixed $value3
+ * @return void Throws an error and does nothing
+ */
 function get_field($table, $return, $field1, $value1, $field2='', $value2='', $field3='', $value3='') {
     error('get_field() not available anymore');
 }
-
+/**
+ * @deprecated
+ * @param mixed $table
+ * @param mixed $oldfield
+ * @param mixed $field
+ * @param mixed $type
+ * @param mixed $size
+ * @param mixed $signed
+ * @param mixed $default
+ * @param mixed $null
+ * @param mixed $after
+ * @return void Throws an error and does nothing
+ */
 function table_column($table, $oldfield, $field, $type='integer', $size='10',
                       $signed='unsigned', $default='0', $null='not null', $after='') {
     error('table_column() was removed, please use new ddl functions');
 }
-
+/**
+ * @deprecated
+ * @param mixed $name
+ * @param mixed $editorhidebuttons
+ * @param mixed $id
+ * @return void Throws an error and does nothing
+ */
 function use_html_editor($name='', $editorhidebuttons='', $id='') {
     error('use_html_editor() not available anymore');
 }