coderkun/questlab
1
0
Fork 0
Code Issues 15 Pull requests Projects Releases Wiki Activity

fix many docstrings and their formatting

Browse source
This commit is contained in:
oliver 2016-05-28 12:30:53 +02:00
commit 7085de8fe2
36 changed files with 679 additions and 659 deletions
Download patch file Download diff file Expand all files Collapse all files

26
questtypes/bossfight/BossfightQuesttypeModel.inc
View file

@ -82,8 +82,8 @@
/**
* Get a Boss-Fight.
*
* @param int $questId ID of Quest
* @return array Boss-Fight data
* @param int $questId ID of Quest
* @return array Boss-Fight data
*/
public function getBossFight($questId)
{
@ -105,8 +105,8 @@
/**
* Get the first Stage to begin the Boss-Fight with.
*
* @param int $questId ID of Quest
* @return array Data of first Stage
* @param int $questId ID of Quest
* @return array Data of first Stage
*/
public function getFirstStage($questId)
{
@ -129,8 +129,8 @@
/**
* Get a Stage by its ID.
*
* @param int $stageId ID of Stage
* @return array Stage data or null
* @param int $stageId ID of Stage
* @return array Stage data or null
*/
public function getStageById($stageId)
{
@ -153,8 +153,8 @@
/**
* Get the follow-up Stages for a Stage.
*
* @param int $parentStageId ID of Stage to get follow-up Stages for
* @return array List of follow-up Stages
* @param int $parentStageId ID of Stage to get follow-up Stages for
* @return array List of follow-up Stages
*/
public function getChildStages($parentStageId)
{
@ -171,7 +171,7 @@
/**
* Reset all Character submissions of a Boss-Fight.
*
* @param int $questId ID of Quest
* @param int $questId ID of Quest
* @param int $characterId ID of Character
*/
public function clearCharacterSubmissions($questId, $characterId)
@ -193,7 +193,7 @@
/**
* Save Character’s submitted answer for one Boss-Fight-Stage.
*
* @param int $regexId ID of list
* @param int $stageId ID of list
* @param int $characterId ID of Character
*/
public function setCharacterSubmission($stageId, $characterId)
@ -214,9 +214,9 @@
/**
* Get answer of one Boss-Fight-Stage submitted by Character.
*
* @param int $regexId ID of list
* @param int $characterId ID of Character
* @return boolean Stage taken
* @param int $stageId ID of list
* @param int $characterId ID of Character
* @return boolean Stage taken
*/
public function getCharacterSubmission($stageId, $characterId)
{

34
questtypes/choiceinput/ChoiceinputQuesttypeModel.inc
View file

@ -111,8 +111,8 @@
/**
* Get choiceinput-text for a Quest.
*
* @param int $questId ID of Quest
* @return array Choiceinput-text
* @param int $questId ID of Quest
* @return array Choiceinput-text
*/
public function getChoiceinputQuest($questId)
{
@ -135,8 +135,8 @@
/**
* Get all lists of input values for a choiceinput-text.
*
* @param int $questId ID of Quest
* @return array List
* @param int $questId ID of Quest
* @return array List
*/
public function getChoiceinputLists($questId)
{
@ -154,8 +154,8 @@
/**
* Get the list of values for a choiceinput-list.
*
* @param int $listId ID of list
* @return array Input values
* @param int $listId ID of list
* @return array Input values
*/
public function getChoiceinputChoices($listId)
{
@ -173,9 +173,9 @@
/**
* Save Character’s submitted answer for one choiceinput-list.
*
* @param int $regexId ID of list
* @param int $characterId ID of Character
* @param string $answer Submitted answer for this list
* @param int $listId ID of list
* @param int $characterId ID of Character
* @param string $answer Submitted answer for this list
*/
public function setCharacterSubmission($listId, $characterId, $answer)
{
@ -211,9 +211,9 @@
/**
* Get answer of one choiceinput-list submitted by Character.
*
* @param int $regexId ID of list
* @param int $characterId ID of Character
* @return int Submitted answer for this list or null
* @param int $listId ID of list
* @param int $characterId ID of Character
* @return int Submitted answer for this list or null
*/
public function getCharacterSubmission($listId, $characterId)
{
@ -236,8 +236,8 @@
/**
* Set the text for a Quest and correct choice input lists count.
*
* @param int $userId ID of user setting text
* @param int $questId ID of Quest to set text for
* @param int $userId ID of user setting text
* @param int $questId ID of Quest to set text for
* @param string $text Text for Quest
*/
public function setTextForQuest($userId, $questId, $text)
@ -300,10 +300,10 @@
/**
* Set list of choices for a text.
*
* @param int $questId ID of Quest to set choices for
* @param int $number List number
* @param int $questId ID of Quest to set choices for
* @param int $number List number
* @param array $choices List of choices
* @param int $correctPos Position of correct answer
* @param int $correctPos Position of correct answer
*/
public function setListForText($questId, $number, $choices, $correctPos)
{

16
questtypes/crossword/CrosswordQuesttypeModel.inc
View file

@ -61,8 +61,8 @@
/**
* Get all words for a crossword-Quest.
*
* @param int $questId ID of Quest
* @return array Words
* @param int $questId ID of Quest
* @return array Words
*/
public function getWordsForQuest($questId)
{
@ -79,9 +79,9 @@
/**
* Save Character’s submitted answer for one crossword-word.
*
* @param int $regexId ID of word
* @param int $characterId ID of Character
* @param string $answer Submitted answer for this word
* @param int $wordId ID of word
* @param int $characterId ID of Character
* @param string $answer Submitted answer for this word
*/
public function setCharacterSubmission($wordId, $characterId, $answer)
{
@ -102,9 +102,9 @@
/**
* Get answer of one crossword-word submitted by Character.
*
* @param int $regexId ID of lisword
* @param int $characterId ID of Character
* @return int Submitted answer for this word or null
* @param int $wordId ID of word
* @param int $characterId ID of Character
* @return int Submitted answer for this word or null
*/
public function getCharacterSubmission($wordId, $characterId)
{

5
questtypes/textinput/TextinputQuesttypeController.inc
View file

@ -32,6 +32,11 @@
*/
const KEY_QUESTTYPEDATA_N_CORRECT_ANSWRES = 'nCorrectAnswers';
/**
* Number of correct answers
*
* @var int
*/
private $nCorrectAnswers = null;