chamilo / chamilo-lms

main/inc/lib/diagnoser.lib.php

Doc Comments +6 added lines

@@ -435,6 +435,12 @@
 
     /**
      * Additional functions needed for fast integration
+     * @param integer $status
+     * @param string $section
+     * @param string $title
+     * @param string $url
+     * @param string|null $formatter
+     * @param string $comment
      */
     public function build_setting(
         $status,

main/inc/lib/exercise.lib.php

Doc Comments +9 added lines, -6 removed lines

@@ -1276,6 +1276,7 @@ 
 
     /**
      * Validates the time control key
+     * @param integer $exercise_id
      */
     public static function exercise_time_control_is_valid(
         $exercise_id,
@@ -1412,7 +1413,7 @@ 
      * @param int $in_direction
      * @param string $in_hotpot_path
      * @param bool $in_get_count
-     * @param null $where_condition
+     * @param string $where_condition
      * @return array|int
      */
     public static function get_exam_results_hotpotatoes_data(
@@ -2215,7 +2216,7 @@ 
     /**
      * Return true if pass_pourcentage activated (we use the pass pourcentage feature
      * return false if pass_percentage = 0 (we don't use the pass pourcentage feature
-     * @param $in_pass_pourcentage
+     * @param string $in_pass_pourcentage
      * @return boolean
      * In this version, pass_percentage and show_success_message are disabled if
      * pass_percentage is set to 0
@@ -2228,7 +2229,7 @@ 
     /**
      * Converts a numeric value in a percentage example 0.66666 to 66.67 %
      * @param $value
-     * @return float Converted number
+     * @return string Converted number
      */
     public static function convert_to_percentage($value)
     {
@@ -2244,7 +2245,7 @@ 
      * @param   float $score
      * @param   float $weight
      * @deprecated seem not to be used
-     * @return  float   the score rounded converted to the new range
+     * @return  string|null   the score rounded converted to the new range
      */
     public static function convert_score($score, $weight)
     {
@@ -2801,6 +2802,7 @@ 
      * @param    int        exercise id
      * @param    int $courseId
      * @param    int        session id
+     * @param integer $user_count
      * @return    float    Best average score
      */
     public static function get_best_average_score_by_exercise(
@@ -3230,8 +3232,9 @@ 
     }
 
     /**
-     * @param array $answer
+     * @param string|null $answer
      * @param string $user_answer
+     * @param string|null $current_answer
      * @return array
      */
     public static function check_fill_in_blanks($answer, $user_answer, $current_answer)
@@ -3858,7 +3861,7 @@ 
 
     /**
      * @param int $countLetter
-     * @return mixed
+     * @return string
      */
     public static function detectInputAppropriateClass($countLetter)
     {

main/webservices/webservice_course.php

Doc Comments +1 added lines

@@ -342,6 +342,7 @@
 	 * @param string User id value
 	 * @param int Set to 1 to subscribe, 0 to unsubscribe
 	 * @param int Status (STUDENT or TEACHER) Used for subscription only
+	 * @param integer $state
 	 * @return mixed True if subscription or unsubscription was successful, false otherwise
 	 */
 	protected function changeUserSubscription($course_id_field_name, $course_id_value, $user_id_field_name, $user_id_value, $state, $status = STUDENT) {

main/work/downloadfolder.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -327,7 +327,7 @@
  * @param array $arr1 first array
  * @param array $arr2 second array
  *
- * @return array difference between the two arrays
+ * @return string difference between the two arrays
  */
 function diff($arr1, $arr2)
 {

main/coursecopy/classes/DummyCourseCreator.class.php

Doc Comments +1 added lines

@@ -272,6 +272,7 @@
     }
     /**
      * Get dummy titles, descriptions and texts
+     * @param string $type
      */
     function get_dummy_content($type)
     {

main/exercice/export/exercise_import.inc.php

Doc Comments -1 removed lines

@@ -1003,7 +1003,6 @@
 /**
  * Processes an IMS/QTI manifest file: store links to new files to be able to transform them into the questions text
  * @param string $filePath The absolute filepath
- * @param array $links List of filepaths changes
  * @return bool
  */
 function qtiProcessManifest($filePath)

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param string $file_comment
      * @param bool $sendToUsersInSession
      *
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

main/inc/lib/fileUpload.lib.php

Doc Comments +10 added lines, -6 removed lines

@@ -17,6 +17,7 @@ 
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  - file_name (string) name of a file
+ * @param string $file_name
  * @return - the filenam phps'ized
  */
 function php2phps($file_name) {
@@ -73,7 +74,7 @@ 
  * Returns the name without extension, used for the title
  *
  * @param string $name
- * @return name without the extension
+ * @return string without the extension
  */
 function get_document_title($name) {
     // If they upload .htaccess...
@@ -86,7 +87,7 @@ 
  * This function checks if the upload succeeded
  *
  * @param array $uploaded_file ($_FILES)
- * @return true if upload succeeded
+ * @return boolean if upload succeeded
  */
 function process_uploaded_file($uploaded_file, $show_output = true)
 {
@@ -738,6 +739,8 @@ 
  * @param  - dir (string) - Path of the directory
  *           whe the file should be added
  * @param  - max_dir_space (int) - maximum size of the diretory in byte
+ * @param string $dir
+ * @param integer $max_dir_space
  * @return - boolean true if there is enough space,
  *				boolean false otherwise
  *
@@ -1062,7 +1065,7 @@ 
  * @param array  $courseInfo
  * @param array  $userInfo
  * @param array  $uploaded_file - follows the $_FILES Structure
- * @param string $upload_path   - destination of the upload.
+ * @param string $uploadPath   - destination of the upload.
  *                               This path is to append to $base_work_dir
  * @param string $base_work_dir  - base working directory of the module
  * @param int    $maxFilledSpace  - amount of bytes to not exceed in the base
@@ -1243,7 +1246,7 @@ 
  * @param int $session_id Session ID, if any
  * @param int $userId creator id
  *
- * @return int id if inserted document
+ * @return string|false id if inserted document
  */
 function add_document(
     $_course,
@@ -1377,7 +1380,7 @@ 
  *
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path+filename eg: /main/document/document.php
- * @return	The directory depth
+ * @return	integer directory depth
  */
 function get_levels($filename) {
     $levels = explode('/', $filename);
@@ -1394,6 +1397,7 @@ 
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path,filename
  * action:	Adds an entry to the document table with the default settings.
+ * @param string $upload_path
  */
 function set_default_settings($upload_path, $filename, $filetype = 'file')
 {
@@ -1818,6 +1822,7 @@ 
 
 @author Roan Embrechts
 @version 0.6
+ * @param string $buffer
  */
 function api_replace_links_in_string($upload_path, $buffer) {
     // Search for hyperlinks
@@ -2053,7 +2058,6 @@ 
  * @param int $groupId
  * @param bool $output
  * @param array $parent
- * @param string $uploadPath
  *
  */
 function add_all_documents_in_folder_to_database(

main/inc/lib/pear/HTML/QuickForm/checkbox.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
      * @param     object    &$caller calling object
      * @since     1.0
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     function onQuickFormEvent($event, $arg, &$caller)
     {