MDL-77164 various: fix incorrect phpdocs

This commit is contained in:
Marina Glancy
2023-04-13 11:35:06 +01:00
parent 4d765cd699
commit 8fc1486d36
327 changed files with 644 additions and 533 deletions
+11 -11
View File
@@ -151,6 +151,7 @@ class flexible_table {
*/
var $started_output = false;
/** @var table_dataformat_export_format */
var $exportclass = null;
/**
@@ -158,16 +159,16 @@ class flexible_table {
*/
private $prefs = array();
/** @var $sheettitle */
/** @var string $sheettitle */
protected $sheettitle;
/** @var $filename */
/** @var string $filename */
protected $filename;
/** @var array $hiddencolumns List of hidden columns. */
protected $hiddencolumns;
/** @var $resetting bool Whether the table preferences is resetting. */
/** @var bool $resetting Whether the table preferences is resetting. */
protected $resetting;
/**
@@ -221,8 +222,8 @@ class flexible_table {
/**
* Get, and optionally set, the export class.
* @param $exportclass (optional) if passed, set the table to use this export class.
* @return table_default_export_format_parent the export class in use (after any set).
* @param table_dataformat_export_format $exportclass (optional) if passed, set the table to use this export class.
* @return table_dataformat_export_format the export class in use (after any set).
*/
function export_class_instance($exportclass = null) {
if (!is_null($exportclass)) {
@@ -532,7 +533,6 @@ class flexible_table {
/**
* Must be called after table is defined. Use methods above first. Cannot
* use functions below till after calling this method.
* @return type?
*/
function setup() {
@@ -567,7 +567,7 @@ class flexible_table {
/**
* Get the order by clause from the session or user preferences, for the table with id $uniqueid.
* @param string $uniqueid the identifier for a table.
* @return SQL fragment that can be used in an ORDER BY clause.
* @return string SQL fragment that can be used in an ORDER BY clause.
*/
public static function get_sort_for_table($uniqueid) {
global $SESSION;
@@ -590,7 +590,7 @@ class flexible_table {
/**
* Prepare an an order by clause from the list of columns to be sorted.
* @param array $cols column name => SORT_ASC or SORT_DESC
* @return SQL fragment that can be used in an ORDER BY clause.
* @return string SQL fragment that can be used in an ORDER BY clause.
*/
public static function construct_order_by($cols, $textsortcols=array()) {
global $DB;
@@ -611,7 +611,7 @@ class flexible_table {
}
/**
* @return SQL fragment that can be used in an ORDER BY clause.
* @return string SQL fragment that can be used in an ORDER BY clause.
*/
public function get_sql_sort() {
return self::construct_order_by($this->get_sort_columns(), $this->column_textsort);
@@ -2246,10 +2246,10 @@ class table_dataformat_export_format extends table_default_export_format_parent
/** @var \core\dataformat\base $dataformat */
protected $dataformat;
/** @var $rownum */
/** @var int $rownum */
protected $rownum = 0;
/** @var $columns */
/** @var array $columns */
protected $columns;
/**