chamilo / chamilo-lms

main/lp/scorm.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -265,7 +265,7 @@ 
      * @param int $userMaxScore
      * @param int $sessionId
      *
-     * @return bool    Returns -1 on error
+     * @return boolean|null    Returns -1 on error
      */
     public function import_manifest(
         $courseCode,
@@ -960,7 +960,7 @@ 
      * @param	string	course Code
      * @param string	LP ID (in database)
      * @param string	Manifest file path (optional if lp_id defined)
-     * @return	integer	New LP ID or false on failure
+     * @return	boolean	New LP ID or false on failure
      * TODO @TODO Implement imsmanifest_path parameter
      */
     public function reimport_manifest($courseCode, $lp_id = null, $imsmanifest_path = '')

main/admin/usergroup_import.php

Doc Comments +2 added lines, -1 removed lines

@@ -9,6 +9,7 @@ 
 
 /**
  * Validates imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $classes
  */
 function validate_data($classes)
 {
@@ -37,7 +38,7 @@ 
 /**
  * Save imported class data to database
  *
- * @param $classes
+ * @param Ddeboer\DataImport\Reader\CsvReader $classes
  *
  * @return int
  */

main/admin/usergroup_user_import.php

Doc Comments +3 added lines, -1 removed lines

@@ -11,6 +11,7 @@ 
 
 /**
  * Validates imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $user_classes
  */
 function validate_data($user_classes)
 {
@@ -67,6 +68,7 @@ 
 
 /**
  * Saves imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $users_classes
  */
 function save_data($users_classes, $deleteUsersNotInList = false)
 {
@@ -119,7 +121,7 @@ 
 /**
  * Reads a CSV-file.
  * @param string $file Path to the CSV-file
- * @return array All course-information read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All course-information read from the file
  */
 function parse_csv_data($file)
 {

main/inc/lib/events.lib.php

Doc Comments +18 added lines, -9 removed lines

@@ -241,7 +241,7 @@ 
     }
 
     /**
-     * @param doc_id id of document (id in mainDb.document table)
+     * @param doc_id string of document (id in mainDb.document table)
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @desc Record information for upload event
      * used in the works tool to record informations when
@@ -317,6 +317,9 @@ 
      * @param   int     session_id
      * @param   int     learnpath_id (id of the learnpath)
      * @param   int     learnpath_item_id (id of the learnpath_item)
+     * @param integer $score
+     * @param integer $weighting
+     * @param integer $session_id
      * @return bool
      *
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
@@ -411,7 +414,9 @@ 
      * @param    integer    Session ID (from the session table). Default value of null means "get from context".
      * @param    integer    Learnpath ID (from c_lp table). Default value of null means "get from context".
      * @param    integer    Learnpath item ID (from the c_lp_item table). Default value of null means "get from context".
-     * @return    boolean    Result of the insert query
+     * @param integer $exe_id
+     * @param integer $position
+     * @return    false|string    Result of the insert query
      */
     public static function saveQuestionAttempt(
         $score,
@@ -976,10 +981,10 @@ 
     }
 
     /**
-     * @param $user_id
+     * @param integer $user_id
      * @param $exerciseId
-     * @param $lp_id
-     * @param $lp_item_id
+     * @param integer $lp_id
+     * @param integer $lp_item_id
      * @return int
      */
     public static function get_attempt_count_not_finished(
@@ -1164,6 +1169,7 @@ 
      * @param   int     exercise id
      * @param   int $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1256,6 +1262,7 @@ 
      * @param   int     exercise id
      * @param   int  $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1347,6 +1354,8 @@ 
      * @param   int     lp id
      * @param   int     lp item id
      * @param   string 	order asc or desc
+     * @param integer $courseId
+     * @param string $order
      * @return  array   with the results
      *
      */
@@ -1413,7 +1422,7 @@ 
      * @param   int     exercise id
      * @param   int     $courseId
      * @param   int     session id
-     * @return  array   with the results
+     * @return  string   with the results
      *
      */
     public static function count_exercise_attempts_by_user(
@@ -1602,7 +1611,7 @@ 
      * @param   int     exercise id
      * @param   int   course id
      * @param   int     session id
-     * @return  array   with the results
+     * @return  integer   with the results
      *
      */
     public static function get_count_exercises_attempted_by_course(
@@ -1836,7 +1845,7 @@ 
      * @param int $user_id ID of the user
      * @param int $sessionId ID of the session (if any)
      *
-     * @return bool
+     * @return boolean|null
      */
     public static function eventCourseLogin($courseId, $user_id, $sessionId)
     {
@@ -2009,7 +2018,7 @@ 
      * in a hh:mm:ss format. If int, we consider it is expressed in hours.
      * @param string $ip IP address to go on record for this time record
      *
-     * @return True on successful insertion, false otherwise
+     * @return boolean on successful insertion, false otherwise
      */
     public static function eventAddVirtualCourseTime(
         $courseId,