chamilo / chamilo-lms

main/exercise/exercise.class.php

Doc Comments +8 added lines, -5 removed lines

@@ -353,7 +353,7 @@ 
     }
 
     /**
-     * @return int
+     * @return string
      */
     public function selectPassPercentage()
     {
@@ -462,7 +462,7 @@ 
      * tells if questions are selected randomly, and if so returns the draws
      *
      * @author Olivier Brouckaert
-     * @return integer - 0 if not random, otherwise the draws
+     * @return boolean - 0 if not random, otherwise the draws
      */
     public function isRandom()
     {
@@ -2830,7 +2830,7 @@ 
      * @param int  int lp id
      * @param int  int lp item id
      * @param int  int lp item_view id
-     * @param float $weight
+     * @param integer $weight
      * @param array question list
      */
     public function save_stat_track_exercise_info(
@@ -5327,6 +5327,9 @@ 
         }
     }
 
+    /**
+     * @param integer $exe_id
+     */
     function send_notification_for_oral_questions($question_list_answers, $origin, $exe_id)
     {
         if (api_get_course_setting('email_alert_manager_on_new_quiz') != 1 ) {
@@ -5478,7 +5481,7 @@ 
      * @param int     Maximum number of attempts (0 if no limit)
      * @param int     Feedback type
      * @todo this was function was added due the import exercise via CSV
-     * @return    int New exercise ID
+     * @return    string New exercise ID
      */
     public function createExercise(
         $title,
@@ -6813,7 +6816,7 @@ 
      * @param bool $show_comment
      * @param null $exercise_feedback
      * @param bool $show_answers
-     * @param null $modelType
+     * @param integer $modelType
      * @param bool $categoryMinusOne
      * @return bool|null|string
      */

main/exercise/export/qti2/qti2_classes.php

Doc Comments +5 added lines

@@ -72,6 +72,7 @@ 
     /**
      * Return the XML flow for the possible answers.
      *
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -147,6 +148,7 @@ 
      * Export the text with missing words.
      *
      *
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -204,6 +206,7 @@ 
 {
     /**
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -295,6 +298,7 @@ 
     /**
      * TODO update this to match hot spots instead of copying matching
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc='', $questionMedia='')
     {
@@ -382,6 +386,7 @@ 
     /**
      * TODO implement
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc='', $questionMedia='')
 	{

main/exercise/hotpotatoes.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -259,7 +259,7 @@ 
  * @param    reference    Reference to the array to search
  * @param    string       Node we are looking for in the array
  * @param string $node
- * @return   mixed        Node name or false if not found
+ * @return   false|string        Node name or false if not found
  */
 function myarraysearch(&$array, $node)
 {
@@ -280,7 +280,7 @@ 
  * Searches an image name into an array.
  * @param    reference        Reference to an array to search
  * @param    string           String to look for
- * @return   mixed            String given if found, false otherwise
+ * @return   false|string            String given if found, false otherwise
  * @uses     myarraysearch    This function is just an additional layer on the myarraysearch() function
  */
 function CheckImageName(&$imgparams, $string)

main/exercise/multiple_answer_true_false.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
      * @param null $feedback_type
      * @param null $counter
      * @param null $score
-     * @return null|string
+     * @return string
      */
     function return_header($feedback_type = null, $counter = null, $score = null)
     {

main/exercise/oral_expression.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
      * @param null $feedback_type
      * @param null $counter
      * @param null $score
-     * @return null|string
+     * @return string
      */
     function return_header($feedback_type = null, $counter = null, $score = null)
     {

main/exercise/question.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -264,7 +264,7 @@
     }
 
     /**
-     * @return string|false
+     * @return string
      */
     public function selectPicturePath()
     {

main/lp/aicc.class.php

Doc Comments +5 added lines, -3 removed lines

@@ -216,7 +216,7 @@ 
     /**
      * Import the aicc object (as a result from the parse_config_files function) into the database structure
      * @param	string	$course_code
-     * @return	bool	Returns -1 on error
+     * @return	false|null	Returns -1 on error
      */
     public function import_aicc($course_code)
     {
@@ -780,7 +780,8 @@ 
      * Static function to parse AICC ini files.
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param	string	File path
-     * @return	array	Structured array
+     * @param string $f
+     * @return	string	Structured array
      */
     function parse_ini_file_quotes_safe($f) {
         $null = '';
@@ -831,7 +832,7 @@ 
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param		string	INI File string
      * @param		array	List of names of sections that should be considered as containing only hard string data (no variables), provided in lower case
-     * @return	array	Structured array
+     * @return	string	Structured array
      */
     function parse_ini_string_quotes_safe($s, $pure_strings = array()) {
         $null = '';
@@ -894,6 +895,7 @@ 
      * @param	string	CSV delimiter
      * @param	string	CSV enclosure
      * @param	boolean	Might one field name happen more than once on the same line? (then split by comma in the values)
+     * @param string $f
      * @return array	Simple structured array
      */
     function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false) {

main/lp/learnpath_functions.inc.php

Doc Comments +1 added lines

@@ -60,6 +60,7 @@
 /**
  * This function deletes an entire directory
  * @param	string	The directory path
+ * @param string $dir
  * @return boolean	True on success, false on failure
  */
 function deldir($dir) {

main/lp/learnpathItem.class.php

Doc Comments +6 added lines, -6 removed lines

@@ -1869,7 +1869,7 @@ 
 
     /**
      * Get the extra terms (tags) that identify this item
-     * @return mixed
+     * @return string
      */
     public function get_terms()
     {
@@ -2069,7 +2069,7 @@ 
 
     /**
      * Opens/launches the item. Initialises runtime values.
-     * @return    boolean    True on success, false on failure.
+     * @return    boolean|null    True on success, false on failure.
      */
     public function open($allow_new_attempt = false)
     {
@@ -3494,7 +3494,7 @@ 
 
     /**
      * Checks if the current status is part of the list of status given
-     * @param  array  $list  An array of status to check for.
+     * @param  string[]  $list  An array of status to check for.
      * If the current status is one of the strings, return true
      *
      * @return boolean True if the status was one of the given strings,
@@ -3671,7 +3671,7 @@ 
     /**
      * Write objectives to DB. This method is separate from write_to_db() because otherwise
      * objectives are lost as a side effect to AJAX and session concurrent access
-     * @return    boolean        True or false on error
+     * @return    boolean|null        True or false on error
      */
     public function write_objectives_to_db()
     {
@@ -4312,7 +4312,7 @@ 
      * Removes the relation between the current item and an audio file. The file
      * is only removed from the lp_item table, but remains in the document table
      * and directory
-     * @return bool
+     * @return false|null
      */
     public function remove_audio()
     {
@@ -4333,7 +4333,7 @@ 
      * @param $status
      * @param bool $decorate
      * @param string $type classic|simple
-     * @return array|string
+     * @return string
      */
     static function humanize_status($status, $decorate = true, $type = 'classic')
     {