From a2780c58b0a2d106289319db051d0f0ea76eab8d Mon Sep 17 00:00:00 2001 From: bdaloukas Date: Sun, 18 Jun 2017 11:11:57 +0300 Subject: [PATCH] phpdoc compatibility --- .../restore_game_activity_task.class.php | 2 + backup/moodle2/restore_game_stepslib.php | 2 + classes/event/course_module_viewed.php | 5 +- cross/cross_class.php | 4 +- hiddenpicture/play.php | 62 ++++++++++++++++++- lib.php | 6 +- locallib.php | 7 ++- mod_form.php | 2 +- print.php | 6 +- sudoku/class.Sudoku.php | 11 +++- sudoku/sdd/class.SDD.php | 4 -- 11 files changed, 90 insertions(+), 21 deletions(-) diff --git a/backup/moodle2/restore_game_activity_task.class.php b/backup/moodle2/restore_game_activity_task.class.php index 8961f83..861a198 100644 --- a/backup/moodle2/restore_game_activity_task.class.php +++ b/backup/moodle2/restore_game_activity_task.class.php @@ -15,6 +15,8 @@ // along with Moodle. If not, see . /** + * Restores a game + * * @package mod_game * @subpackage backup-moodle2 * @copyright 2007 Vasilis Daloukas diff --git a/backup/moodle2/restore_game_stepslib.php b/backup/moodle2/restore_game_stepslib.php index 9e03b24..fd9b181 100644 --- a/backup/moodle2/restore_game_stepslib.php +++ b/backup/moodle2/restore_game_stepslib.php @@ -27,6 +27,8 @@ defined('MOODLE_INTERNAL') || die(); /** * Structure step to restore one game activity + * @copyright 2007 Vasilis Daloukas + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class restore_game_activity_structure_step extends restore_activity_structure_step { diff --git a/classes/event/course_module_viewed.php b/classes/event/course_module_viewed.php index 119eb17..4800141 100644 --- a/classes/event/course_module_viewed.php +++ b/classes/event/course_module_viewed.php @@ -57,8 +57,9 @@ class course_module_viewed extends \core\event\course_module_viewed { /** * Create instance of event. - * @param stdClass $game - * @param stdClass $context + * + * @param $game + * @param $context * * @return event */ diff --git a/cross/cross_class.php b/cross/cross_class.php index b10cdd3..ae00d92 100644 --- a/cross/cross_class.php +++ b/cross/cross_class.php @@ -512,8 +512,8 @@ class Cross /** * Swaps two variables. * - * @param $a - * @param $b + * @param &$a + * @param &$b */ public function swap( &$a, &$b) { $temp = $a; diff --git a/hiddenpicture/play.php b/hiddenpicture/play.php index cbf7b73..8bdf068 100644 --- a/hiddenpicture/play.php +++ b/hiddenpicture/play.php @@ -24,6 +24,7 @@ */ defined('MOODLE_INTERNAL') || die(); + /** * Plays the game "Hidden picture" * @@ -112,7 +113,13 @@ function game_hiddenpicture_continue( $id, $game, $attempt, $hiddenpicture, $con game_hiddenpicture_play( $id, $game, $attempt, $newrec, false, $context); } -// Create the game_hiddenpicture record. + +/** + * Create the game_hiddenpicture record. + * + * @param $game + * @param $attempt + */ function game_hiddenpicture_selectglossaryentry( $game, $attempt) { global $CFG, $DB, $USER; @@ -223,6 +230,16 @@ function game_hiddenpicture_selectglossaryentry( $game, $attempt) { return $newrec; } +/** + * Plays the game "Hidden picture" + * + * @param $id + * @param $game + * @param $attempt + * @param $hiddenpicture + * @param $showsolution + * @param $context + */ function game_hiddenpicture_play( $id, $game, $attempt, $hiddenpicture, $showsolution, $context) { if ($game->toptext != '') { echo $game->toptext.'
'; @@ -256,6 +273,12 @@ function game_hiddenpicture_play( $id, $game, $attempt, $hiddenpicture, $showsol } } +/** + * "Hidden picture" compute score + * + * @param $game + * @param $hiddenpicture + */ function game_hidden_picture_computescore( $game, $hiddenpicture) { $correct = $hiddenpicture->correct; if ($hiddenpicture->found) { @@ -272,6 +295,15 @@ function game_hidden_picture_computescore( $game, $hiddenpicture) { return $percent; } +/** + * Show hidden picture + * + * @param $id + * @param $game + * @param $attempt + * @param $hiddenpicture + * @param $showsolution + */ function game_hiddenpicture_showhiddenpicture( $id, $game, $attempt, $hiddenpicture, $showsolution, $offsetquestions, $correctquestions) { global $DB; @@ -300,6 +332,13 @@ function game_hiddenpicture_showhiddenpicture( $id, $game, $attempt, $hiddenpict game_showpicture( $id, $game, $attempt, $query, $cells, $foundcells, true); } +/** + * hidden picture. show question glossary + * + * @param $game + * @param $id + * @param $query + */ function game_hiddenpicture_showquestion_glossary( $game, $id, $query) { global $CFG, $DB; @@ -331,6 +370,16 @@ function game_hiddenpicture_showquestion_glossary( $game, $id, $query) { echo "
\n"; } +/** + * Check main question + * + * @param $id + * @param $game + * @param $attempt + * @param $hiddenpicture + * @param $finishattempt + * @param $context + */ function game_hiddenpicture_check_mainquestion( $id, $game, &$attempt, &$hiddenpicture, $finishattempt, $context) { global $CFG, $DB; @@ -396,6 +445,17 @@ function game_hiddenpicture_check_mainquestion( $id, $game, &$attempt, &$hiddenp return false; } +/** + * Show picture + * + * @param $id + * @param $game + * @param $attempt + * @param $query + * @param $cells + * @param $foundcells + * @param $usemap + */ function game_showpicture( $id, $game, $attempt, $query, $cells, $foundcells, $usemap) { global $CFG; diff --git a/lib.php b/lib.php index 08dd788..faeb094 100644 --- a/lib.php +++ b/lib.php @@ -263,7 +263,7 @@ function game_user_outline($course, $user, $mod, $game) { } /** - * Print a detailed representation of what a user has done with a given particular instance of this module, for user activity reports. + * Print a detailed representation of what a user has done with a given particular game,(user activity reports). * @param stdClass $course * @param stdClass $user @@ -379,7 +379,7 @@ function game_get_user_grades($game, $userid=0) { } /** - * Must return an array of user records (all data) who are participants for a given instance of game. Must include every user involved + * Must return an array of user records (all data) who are participants for a given instance of game. * * @param int $gameid ID of an instance of this module * @return mixed boolean/array of students @@ -1208,7 +1208,7 @@ function mod_game_pluginfile($course, $cm, $context, $filearea, $args, $forcedow } /** - * Implementation of the function for printing the form elements that control whether the course reset functionality affects the Game. + * Add reset buttons to form. * * @param object $mform form passed by reference */ diff --git a/locallib.php b/locallib.php index dbd775e..a2bb879 100644 --- a/locallib.php +++ b/locallib.php @@ -1071,7 +1071,8 @@ function game_get_user_attempts( $gameid, $userid, $status = 'finished') { /** - * Returns an unfinished attempt (if there is one) for the given user on the given game. This function does not return preview attempts. + * Returns an unfinished attempt (if there is one) for the given user on the given game. + * This function does not return preview attempts. * * @param integer $gameid the id of the game. * @param integer $userid the id of the user. @@ -1555,7 +1556,7 @@ function game_filterquestion_answer( $questiontext, $questionid, $contextid, $co * @param $text * @param $courseid */ - function game_filtertext( $text, $courseid) { +function game_filtertext( $text, $courseid) { $formatoptions = new stdClass(); $formatoptions->noclean = true; $formatoptions->filter = 1; @@ -2518,7 +2519,7 @@ function game_strpos( $haystack, $needle, $offset = 0) { /** * show query * - * @param object $game the game + * @param object $game the game * @param $query * @param $text */ diff --git a/mod_form.php b/mod_form.php index ee85732..6c3c815 100644 --- a/mod_form.php +++ b/mod_form.php @@ -17,7 +17,7 @@ /** * Form for creating and modifying a game * - * @package game + * @package mod_game * @author Alastair Munro * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/print.php b/print.php index ad90423..75a83b8 100644 --- a/print.php +++ b/print.php @@ -55,9 +55,9 @@ function game_print( $game, $update, $context) { /** * Prints a cross. * - * @param stdClass $game - @param boolean $update - * @param stdClass $context + * @param $game + @param $update + * @param $context */ function game_print_cross( $game, $update, $context) { require( "cross/play.php"); diff --git a/sudoku/class.Sudoku.php b/sudoku/class.Sudoku.php index 910e74c..acb7608 100644 --- a/sudoku/class.Sudoku.php +++ b/sudoku/class.Sudoku.php @@ -144,10 +144,14 @@ class objects { * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class cell extends objects { + /** @var $r */ protected $r; + /** @var $c */ protected $c; + /** @var $state */ protected $state = array(); + /** @var $applied */ protected $applied = false; /** @@ -746,7 +750,10 @@ class r extends rcs { */ /** - * @see RCS::coupling + * see RCS::coupling + * + * @param $therow + * @param $thecolumn */ public function coupling($therow, $thecolumn) { return $thestate = $this->_coupling($thecolumn); @@ -755,7 +762,7 @@ class r extends rcs { /** * Heavy lifting for row/column coupling calculations. * - * @see RCS::coupling + * RCS::coupling * @param integer $theIndex the index of the cell within the row or column. * @return integer the "coupling coefficient" for the cell. The sum of the * sizes of the intersection between this and all other diff --git a/sudoku/sdd/class.SDD.php b/sudoku/sdd/class.SDD.php index a20a356..97aa00d 100644 --- a/sudoku/sdd/class.SDD.php +++ b/sudoku/sdd/class.SDD.php @@ -71,8 +71,6 @@ class sdd { /* * Close the log file. - * - * @abstract */ public function close() { } @@ -279,7 +277,6 @@ class sdd { /* * Write a debugging value to a log file. * - * @abstract * @param mixed Data to be logged. * @param string $theHeader [optional] string to be emitted prior to * logging the data. By default it is a date/time @@ -348,7 +345,6 @@ class sdd { /* * Write data to the log file. * - * @abstract * @parameter string $theData [by reference] the data to be written * into the log file. * @return integer the number of bytes written into the log file.