Browse Source

phpdoc compatibility

MOODLE_20_STABLE
bdaloukas 8 years ago
parent
commit
9d6ca6d5f9
  1. 13
      sudoku/class.Sudoku.php

13
sudoku/class.Sudoku.php

@ -339,17 +339,15 @@ class rcs extends ObjectS {
/** /**
* Constructor * Constructor
* *
* This interface is what limts things to 9x9 Sudoku currently * This interface is what limts things to 9x9 Sudoku currently
* @param string $thetag "Row", "Column", "Square", used primarily in debugging. * @param string $thetag "Row", "Column", "Square", used primarily in debugging.
* @param integer $theindex 1..9, where is this on the board. Square are numbered top * @param integer $theindex 1..9, where is this on the board. Square are numbered top left, ending bottom right
* left, ending bottom right
* @param ObjectS $a1 of class Cell. * @param ObjectS $a1 of class Cell.
* @param ObjectS $a2 of class Cell. * @param ObjectS $a2 of class Cell.
* @param ObjectS $a3 of class Cell. * @param ObjectS $a3 of class Cell.
* @param ObjectS $a4 of class Cell. * @param ObjectS $a4 of class Cell.
* @param ObjectS $a5 of class Cell. * @param ObjectS $a5 of class Cell.
* @param ObjectS $a6 of class Cell. * @param ObjectS $a6 of class Cell.
* @param ObjectS $a6 of class Cell.
* @param ObjectS $a7 of class Cell. * @param ObjectS $a7 of class Cell.
* @param ObjectS $a8 of class Cell. * @param ObjectS $a8 of class Cell.
* @param ObjectS $a9 of class Cell. * @param ObjectS $a9 of class Cell.
@ -1082,7 +1080,7 @@ class sudoku extends ObjectS {
* Given a solution, see if there are any alternates within the solution. * Given a solution, see if there are any alternates within the solution.
* In theory this should return the "minimum" solution given any solution. * In theory this should return the "minimum" solution given any solution.
* *
* @param array $theinitialState * @param array $theinitialstate
* *
* @return array A set of triples containing the minimum solution. * @return array A set of triples containing the minimum solution.
*/ */
@ -1121,7 +1119,7 @@ class sudoku extends ObjectS {
* plays sudoku wants a variety of difficulties this controls that. * plays sudoku wants a variety of difficulties this controls that.
* 1 is the easiest, 10 the most difficult. The easier Sudoku have * 1 is the easiest, 10 the most difficult. The easier Sudoku have
* extra information. * extra information.
* @param integer $themaxinterations [optional] Controls the number of iterations * @param integer $themaxiterations [optional] Controls the number of iterations
* before the puzzle generator gives up and trys a different set * before the puzzle generator gives up and trys a different set
* of initial parameters. * of initial parameters.
* @param integer $thetrys [optional] The number of attempts at resetting the * @param integer $thetrys [optional] The number of attempts at resetting the
@ -1701,6 +1699,9 @@ class sudoku extends ObjectS {
* There's a bit of bookkeeping to keep the state right when backing up, but that's pretty * There's a bit of bookkeeping to keep the state right when backing up, but that's pretty
* straightforward and looks a lot like that of generatePuzzle. * straightforward and looks a lot like that of generatePuzzle.
* *
* @param int $i
* @param int $j
*
* @return array The clues added sufficient to solve the puzzle. * @return array The clues added sufficient to solve the puzzle.
*/ */
public function solvebruteforce($i = 1, $j = 1) { public function solvebruteforce($i = 1, $j = 1) {

Loading…
Cancel
Save