Dev: More phpdoc for retrieveAnswers

LimeSurvey · Sep 3, 2016 · 3c4c4dc · Shnoulle · Sep 4, 2016 · olleharstedt
1 parent 4f56537
commit 3c4c4dc
Showing 1 changed file with 14 additions and 2 deletions.
diff --git a/application/helpers/qanda_helper.php b/application/helpers/qanda_helper.php
@@ -73,8 +73,20 @@ function setNoAnswerMode($thissurvey)
 * and a list of the question/answer fieldnames associated. It is called from
 * question.php, group.php, survey.php or preview.php
 *
-* @param mixed $ia
-* @return mixed
+* @param array $ia Details of $ia can be found at top of this file
+* @return array Array like [array $qanda, array $inputnames] where
+*               $qanda has elements [
+*                 $qtitle : string? what's the content?
+*                 $answer ?
+*                 'help' : string
+*                 $display : ?
+*                 $qid  : integer
+*                 $ia[2]
+*                 $ia[5] = group id : int
+*                 $ia[1] = fieldname : string
+*               ]
+*               and $inputnames is ? used for hiddenfieldnames and upload file?
+*
 */
 function retrieveAnswers($ia)
 {