phpdoc compatibility

classes/event/course_module_viewed.php

@@ -58,8 +58,8 @@ class course_module_viewed extends \core\event\course_module_viewed {
     /**
      * Create instance of event.
      *
-     * @param $game
+     * @param stdClass $game
-     * @param $context
+     * @param context_module $context
      *
      * @return event
      */

cross/cross_class.php

@@ -512,8 +512,8 @@ class Cross
     /**
      * Swaps two variables.
      *
-     * @param &$a
+     * @param object $a
-     * @param &$b
+     * @param object $b
      */
     public function swap( &$a, &$b) {
         $temp = $a;
@@ -572,11 +572,11 @@ class Cross
      * @param int $valblanc
      * @param string $puzzle
      * @param array $words
-     * @param $magics
+     * @param object $magics
-     * @param $poss
+     * @param object $poss
-     * @param $ccrosspos
+     * @param int $ccrosspos
-     * @param $crossdir
+     * @param int $crossdir
-     * @param $crosssword
+     * @param object $crosssword
      * @param int $n20
      *
      * @return true if it is ok.
@@ -709,9 +709,9 @@ class Cross
     /**
      * my_preg_match (backward compatibility).
      *
-     * @param $w
+     * @param string $w
-     * @param $words
+     * @param string $words
-     * @param $word
+     * @param string $word
      *
      * @return true if it is ok.
      */
@@ -744,9 +744,9 @@ class Cross
     /**
      * Set a char to the specified position.
      *
-     * @param $s
+     * @param string $s
-     * @param $pos
+     * @param int $pos
-     * @param $char
+     * @param string $char
      */
     public function setchar( &$s, $pos, $char) {
         $ret = "";
@@ -761,8 +761,8 @@ class Cross
     /**
      * Show html base.
      *
-     * @param $crossm
+     * @param object $crossm
-     * @param $crossd
+     * @param object $crossd
      * @param boolean $showsolution
      * @param boolean $showhtmlsolutions
      * @param boolean $showstudentguess

cross/crossdb_class.php

@@ -32,9 +32,6 @@ defined('MOODLE_INTERNAL') || die();
  * @author  bdaloukas
  * @package game
  **/
-
-defined('MOODLE_INTERNAL') || die();
-
 class CrossDB extends Cross {
     /**
      * Save cross.

cryptex/cryptexdb_class.php

@@ -39,7 +39,7 @@ class CryptexDB extends CrossDB {
      * @param array $crossm
      * @param array $crossd
      * @param int $id
-     * @param $letters
+     * @param string $letters
      *
      * @return the saved record
      */
@@ -134,12 +134,12 @@ class CryptexDB extends CrossDB {
     /**
      * Displays the cryptex.
      *
-     * @param $cols
+     * @param int $cols
-     * @param $rows
+     * @param int $rows
-     * @param $letters
+     * @param string $letters
-     * @param $mask
+     * @param string $mask
-     * @param $showsolution
+     * @param boolean $showsolution
-     * @param $textdir
+     * @param boolean $textdir
      */
     public function displaycryptex( $cols, $rows, $letters, $mask, $showsolution, $textdir) {
         echo "<table border=1 $textdir>";

db/importsnakes.php

@@ -70,6 +70,8 @@ function game_importsnakes() {
 
 /**
   * Insert one board to database
+  *
+  * @param $newrec
   */ 
 function game_importsnakes_do( $newrec) {
     global $DB;

export/exporthtml_millionaire.php

@@ -29,11 +29,11 @@ defined('MOODLE_INTERNAL') || die();
  *
  * @param stdClass $game
  * @param stdClass $context
- * @param $maxanswers
+ * @param int $maxanswers
- * @param $countofquestions
+ * @param int $countofquestions
- * @param $retfeedback
+ * @param string $retfeedback
- * @param $destdir
+ * @param string $destdir
- * @param $files
+ * @param array $files
  */
 function game_millionaire_html_getquestions( $game, $context, &$maxanswers, &$countofquestions, &$retfeedback, $destdir, &$files) {
     global $CFG, $DB, $USER;

hangman/play.php

@@ -27,13 +27,13 @@ defined('MOODLE_INTERNAL') || die();
 /**
  * Plays the game hangman
  *
- * @param $id
+ * @param int $id
- * @param $game
+ * @param stdClass $game
- * @param $attempt
+ * @param stdClass $attempt
- * @param $hangman
+ * @param stdClass $hangman
- * @param $newletter
+ * @param string $newletter
- * @param $action
+ * @param string $action
- * @param $context
+ * @param stdClass $context
  */
 function game_hangman_continue( $id, $game, $attempt, $hangman, $newletter, $action, $context) {
     global $DB, $USER;
@@ -233,13 +233,13 @@ function game_hangman_onfinishgame( $game, $attempt, $hangman) {
 /**
  * Plays the hangman game.
  *
- * @param $id
+ * @param int $id
- * @param $game
+ * @param stdClass $game
- * @param $attempt
+ * @param stdClass $attempt
- * @param $hangman
+ * @param stdClass $hangman
- * @param $onlyshow
+ * @param boolean $onlyshow
- * @param $showsolution
+ * @param boolean $showsolution
- * @param $context
+ * @param stdClass $context
  */
 function game_hangman_play( $id, $game, $attempt, $hangman, $onlyshow, $showsolution, $context) {
     global $CFG, $DB, $OUTPUT;
@@ -321,20 +321,20 @@ function game_hangman_play( $id, $game, $attempt, $hangman, $onlyshow, $showsolu
 /**
  * Shows page.
  *
- * @param $done
+ * @param boolean $done
- * @param $correct
+ * @param boolean $correct
- * @param $wrong
+ * @param boolean $wrong
- * @param $max
+ * @param int $max
- * @param wordline
+ * @param string wordline
- * @param $wordline2
+ * @param string $wordline2
- * @param $links
+ * @param array $links
  * @param stdClass $game
- * @param $attempt
+ * @param stdClass $attempt
- * @param $hangman
+ * @param stdClass $hangman
- * @param $query
+ * @param stdClass $query
- * @param $onlyshow
+ * @param boolean $onlyshow
- * @param $showsolution
+ * @param boolean $showsolution
- * @param $context
+ * @param stdClass $context
  */
 function hangman_showpage(&$done, &$correct, &$wrong, $max, &$wordline, &$wordline2, &$links,
     $game, &$attempt, &$hangman, &$query, $onlyshow, $showsolution, $context) {
@@ -484,12 +484,12 @@ function hangman_showpage(&$done, &$correct, &$wrong, $max, &$wordline, &$wordli
 /**
  * This word is correct. If reach the max number of words I have to finish else continue with next word.
  *
- * @param $id
+ * @param int $id
- * @param $wordline
+ * @param string $wordline
- * @param $game
+ * @param stdClass $game
- * @param $attempt
+ * @param stdClass $attempt
- * @param $hangman
+ * @param stdClass $hangman
- * @param $query
+ * @param stdClass $query
  */
 function hangman_oncorrect( $id, $wordline, $game, $attempt, $hangman, $query) {
     global $DB;
@@ -510,14 +510,14 @@ function hangman_oncorrect( $id, $wordline, $game, $attempt, $hangman, $query) {
 /**
  * On incorrect.
  *
- * @param $id
+ * @param int $id
- * @param $wordline
+ * @param string $wordline
- * @param $word
+ * @param string $word
- * @param $game
+ * @param stdClass $game
- * @param $attempt
+ * @param stdClass $attempt
- * @param $hangman
+ * @param stdClass $hangman
- * @param $onlyshow
+ * @param boolean $onlyshow
- * @param $showsolution
+ * @param boolean $showsolution
  */
 function hangman_onincorrect( $id, $wordline, $word, $game, $attempt, $hangman, $onlyshow, $showsolution) {
     echo "\r\n<br/><br/><font size=\"5\">\n$wordline</font>\r\n";
@@ -544,10 +544,10 @@ function hangman_onincorrect( $id, $wordline, $word, $game, $attempt, $hangman,
 /**
  * Shows the next word.
  *
- * @param $id
+ * @param int $id
- * @param $game
+ * @param stdClass $game
- * @param $attempt
+ * @param stdClass $attempt
- * @param $hangman
+ * @param stdClass $hangman
  */
 function game_hangman_show_nextword( $id, $game, $attempt, $hangman) {
     global $CFG, $DB;

hiddenpicture/play.php

@@ -28,11 +28,11 @@ defined('MOODLE_INTERNAL') || die();
 /**
  * Plays the game "Hidden picture"
  *
- * @param $id
+ * @param int $id
- * @param $game
+ * @param stdClass $game
- * @param $attempt
+ * @param stdClass $attempt
- * @param $hiddenpicture
+ * @param stdClass $hiddenpicture
- * @param $context
+ * @param stdClass $context
  */
 function game_hiddenpicture_continue( $id, $game, $attempt, $hiddenpicture, $context) {
     global $DB, $USER;
@@ -117,8 +117,8 @@ function game_hiddenpicture_continue( $id, $game, $attempt, $hiddenpicture, $con
 /**
  * Create the game_hiddenpicture record.
  *
- * @param $game
+ * @param stdClass $game
- * @param $attempt
+ * @param stdClass $attempt
  */
 function game_hiddenpicture_selectglossaryentry( $game, $attempt) {
     global $CFG, $DB, $USER;

lib.php

@@ -55,7 +55,8 @@ define('GAME_REVIEW_GENERALFEEDBACK', 32 * 0x1041); // Show general feedback.
 /**
  * Given an object containing all the necessary data, will create a new instance and return the id number of the new instance.
  *
- * @param object $instance An object from the form in mod.html
+ * @param object $game An object from the form in mod.html
+ *
  * @return int The id of the newly inserted game record
  **/
 function game_add_instance($game) {
@@ -79,7 +80,7 @@ function game_add_instance($game) {
 /**
  * Given an object containing all the necessary data, this function will update an existing instance with new data.
  *
- * @param object $instance An object from the form in mod.html
+ * @param object $game An object from the form in mod.html
  * @return boolean Success/Fail
  **/
 function game_update_instance($game) {
@@ -237,10 +238,10 @@ function game_delete_instance($gameid) {
 /**
  * Return a small object with summary information about what a user has done
  *
- * @param $course
+ * @param stdClass $course
- * @param $user
+ * @param stdClass $user
- * @param $mod
+ * @param string $mod
- * @param $game
+ * @param stdClass $game
  *
  * $return->time = the time they did it
  * $return->info = a short text description

locallib.php

@@ -1992,6 +1992,13 @@ foreach ($anss as $answer) {
 <?php
 }
 
+/**
+ * Print question show answer
+ *
+ * @param stdClass $game
+ * @param stdClass $question
+ * @param $context
+ */
 function game_print_question_shortanswer( $game, $question, $context) {
     $questiontext = $question->questiontext;
 

print.php

@@ -40,9 +40,9 @@ game_print( $game, $id, $context);
 /**
  * Print
  *
- * @param $game
+ * @param stdClass $game
- * @param $update
+ * @param boolean $update
- * @param $context
+ * @param stdClass $context
  */
 function game_print( $game, $update, $context) {
     if ( $game->gamekind == 'cross') {

report/default.php

@@ -51,9 +51,9 @@ class game_default_report {
     /**
      * Display
      *
-     * @param $cm
+     * @param stdClass $cm
-     * @param $course
+     * @param stdClass $course
-     * @param $game
+     * @param stdClass $game
      */
     public function display($cm, $course, $game) {
         // This function just displays the report.
@@ -63,11 +63,11 @@ class game_default_report {
     /**
      * print header and tabs
      *
-     * @param $cm
+     * @param stdClass $cm
-     * @param $course
+     * @param stdClass $course
-     * @param $game
+     * @param stdClass $game
-     * @param $reportmode
+     * @param string $reportmode
-     * @param $meta
+     * @param string $meta
      */
     public function print_header_and_tabs($cm, $course, $game, $reportmode = "overview", $meta = "") {
         global $CFG;

translate.php

@@ -255,7 +255,7 @@ if ($ret != '') {
 /**
  * Returns the language file for lang
  *
- * @param $lang
+ * @param string $lang
  * @param string module
  * @return the path of language file
  */
@@ -272,8 +272,8 @@ function getlangfile( $lang) {
 /**
  * Reads the language file
  *
- * @param $lang
+ * @param string $lang
- * @param  $header
+ * @param string $header
  */
 function readlangfile( $lang, &$header) {
 
@@ -341,7 +341,7 @@ function splitlangdefinition($line, &$name, &$trans) {
  * Read source code
  *
  * @param string $file
- * @param $strings
+ * @param string $strings
  */
 function readsourcecode( $file, &$strings) {
     global $CFG;
@@ -357,7 +357,7 @@ function readsourcecode( $file, &$strings) {
 /**
  * Parse line
  *
- * @param $strings
+ * @param string $strings
  * @param string $line
  * @param string $filename
  */