chamilo / chamilo-lms

main/exercice/hotpotatoes_exercise_result.class.php

Doc Comments +1 added lines

@@ -18,6 +18,7 @@
 	 * Gets the results of all students (or just one student if access is limited)
 	 * @param	string		The document path (for HotPotatoes retrieval)
 	 * @param	integer		User ID. Optional. If no user ID is provided, we take all the results. Defauts to null
+	 * @param string $document_path
 	 */
 	public function getExercisesReporting($document_path, $hotpotato_name)
     {

main/exercice/hotspot.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	/**
 	 * @param FormValidator $form
 	 * @param null $objExercise
-	 * @return bool
+	 * @return null|false
 	 */
 	public function processCreation($form, $objExercise = null)
 	{

main/exercice/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/exercice/question.class.php

Doc Comments +8 added lines, -5 removed lines

@@ -265,7 +265,7 @@ 
     }
 
     /**
-     * @return bool|string
+     * @return string|false
      */
     public function selectPicturePath()
     {
@@ -590,7 +590,7 @@ 
      * @param string $Dimension - Resizing happens proportional according to given dimension: height|width|any
      * @param integer $Max - Maximum size
      *
-     * @return boolean - true if success, false if failed
+     * @return boolean|null - true if success, false if failed
      *
      * @author Toon Keppens
      */
@@ -751,6 +751,7 @@ 
 
     /**
      * Sets extra info
+     * @param string $extra
      */
     public function setExtra($extra)
     {
@@ -1261,7 +1262,7 @@ 
      *
      * @author Olivier Brouckaert
      * @param  array   Course info of the destination course
-     * @return int     ID of the new question
+     * @return false|string     ID of the new question
      */
     public function duplicate($course_info = null)
     {
@@ -1636,7 +1637,7 @@ 
      * @param string $name
      * @param int $course_id
      * @param int $position
-     * @return bool|int
+     * @return false|string
      */
     static function saveQuestionOption($question_id, $name, $course_id, $position = 0)
     {
@@ -1775,6 +1776,7 @@ 
      * @param   int     Maximum result for the question
      * @param   int     Type of question (see constants at beginning of question.class.php)
      * @param   int     Question level/category
+     * @param string $quiz_id
      */
     public function create_question(
         $quiz_id,
@@ -1857,6 +1859,7 @@ 
     /**
      * Get course medias
      * @param int course id
+     * @param integer $course_id
      */
     static function get_course_medias(
         $course_id,
@@ -1922,7 +1925,7 @@ 
     }
 
     /**
-     * @return array
+     * @return integer[]
      */
     public static function get_default_levels()
     {

main/exercice/TestCategory.php

Doc Comments +2 added lines, -2 removed lines

@@ -474,6 +474,7 @@ 
 
 	/**
 	 * return a tab of $in_number random elements of $in_tab
+	 * @param integer $in_number
 	 */
     public static function getNElementsFromArray($in_tab, $in_number)
     {
@@ -650,7 +651,6 @@ 
     /**
      * Return the id of the test category with title = $in_title
      * @param $in_title
-     * @param int $in_c_id
      *
      * @return int is id of test category
      */
@@ -678,7 +678,7 @@ 
      * @param int $questionId
      * @param int $courseId
 	 *
-	 * @return int
+	 * @return string|false
      */
     public static function add_category_for_question_id($categoryId, $questionId, $courseId)
     {

main/exercice/unique_answer.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -417,8 +417,8 @@
      * @param int $question_id  The question ID (to which the answer is attached)
      * @param string $title The text of the answer
      * @param string $comment The feedback for the answer
-     * @param float|null $score  The score you get when picking this answer
-     * @param int|null $correct  Whether this answer is considered *the* correct one (this is the unique answer type)
+     * @param double $score  The score you get when picking this answer
+     * @param integer $correct  Whether this answer is considered *the* correct one (this is the unique answer type)
      */
     public function addAnswer(
         $id,

main/forum/forumfunction.inc.php

Doc Comments +16 added lines, -7 removed lines

@@ -1058,7 +1058,7 @@ 
  * an up and down icon except for the first (no up icon) and the last (no down icon)
  *          The key of this $list array is the id of the item.
  *
- * @return void HTML
+ * @return string HTML
  **/
 function return_up_down_icon($content, $id, $list)
 {
@@ -2011,7 +2011,7 @@ 
  * This function retrieves forum thread users details
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  resource array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author Christian Fasanando <christian.fasanando@dokeos.com>,
  * @todo     this function need to be improved
  * @version octubre 2008, dokeos 1.8
@@ -2066,7 +2066,7 @@ 
  * This function retrieves forum thread users qualify
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author Jhon Hinojosa
  * @todo     this function need to be improved
  */
@@ -2133,7 +2133,7 @@ 
  * This function retrieves forum thread users not qualify
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author   Jhon Hinojosa<jhon.hinojosa@dokeos.com>,
  * @version oct 2008, dokeos 1.8
  */
@@ -3163,6 +3163,10 @@ 
  * @param integer contains the information the current user id
  * @param integer contains the information the current thread id
  * @param integer contains the information the current qualify
+ * @param string $option
+ * @param integer $course_id
+ * @param integer $user_id
+ * @param integer $thread_id
  * @return void
  * <code>$option=1 obtained the qualification of the current thread</code>
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
@@ -3722,6 +3726,8 @@ 
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
+ * @param string $last_post_id
+ * @param string $post_date
  */
 function updateThreadInfo($thread_id, $last_post_id, $post_date)
 {
@@ -4025,6 +4031,8 @@ 
  *
  * @param string  Content type (post, thread, forum, forum_category)
  * @param int     Item DB ID
+ * @param string $content
+ * @param integer $id
  * @return string language variable
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
@@ -4461,6 +4469,7 @@ 
 /**
  * Display the search results
  * @param string
+ * @param string $search_term
  * @return void display the results
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version march 2008, dokeos 1.8.5
@@ -4590,7 +4599,7 @@ 
  * This function adds an attachment file into a forum
  * @param string $file_comment  a comment about file
  * @param int $last_id from forum_post table
- * @return int|bool
+ * @return false|null
  */
 function add_forum_attachment_file($file_comment, $last_id)
 {
@@ -4801,7 +4810,7 @@ 
  * @param post id
  * @param int $id_attach
  * @param bool $display to show or not result message
- * @return void
+ * @return integer
  * @author Julio Montoya Dokeos
  * @version october 2014, chamilo 1.9.8
  */
@@ -5083,7 +5092,7 @@ 
  * @param integer $forum_id the id of the forum
  * @param integer $thread_id the id of the thread
  * @param integer $post_id the id of the post
- * @return bool
+ * @return false|null
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version May 2008, dokeos 1.8.5

main/gradebook/lib/be/abstractlink.class.php

Doc Comments +15 added lines, -4 removed lines

@@ -193,6 +193,9 @@ 
         $this->visible = $visible;
     }
 
+    /**
+     * @param integer $id
+     */
     public function set_session_id($id)
     {
         $this->session_id = $id;
@@ -217,6 +220,12 @@ 
     /**
      * Retrieve links and return them as an array of extensions of AbstractLink.
      * To keep consistency, do not call this method but LinkFactory::load instead.
+     * @param integer $id
+     * @param integer $type
+     * @param integer $user_id
+     * @param string $course_code
+     * @param integer $category_id
+     * @param integer $visible
      */
     public static function load(
         $id = null,
@@ -288,7 +297,7 @@ 
     }
 
     /**
-     * @param $result
+     * @param Doctrine\DBAL\Driver\Statement|null $result
      * @return array
      */
     private static function create_objects_from_sql_result($result)
@@ -463,6 +472,7 @@ 
 
     /**
      * Internal function used by get_target_categories()
+     * @param integer $level
      */
     private function add_target_subcategories($targets, $level, $catid)
     {
@@ -492,6 +502,7 @@ 
      * Find links by name
      * To keep consistency, do not call this method but LinkFactory::find_links instead.
      * @todo can be written more efficiently using a new (but very complex) sql query
+     * @param string $name_mask
      */
     public function find_links ($name_mask,$selectcat)
     {
@@ -559,21 +570,21 @@ 
     }
 
     /**
-     * @param $name
+     * @param string $name
      */
     public function set_name($name)
     {
     }
 
     /**
-     * @param $description
+     * @param string $description
      */
     public function set_description($description)
     {
     }
 
     /**
-     * @param $max
+     * @param integer $max
      */
     public function set_max($max)
     {

main/gradebook/lib/be/category.class.php

Doc Comments +22 added lines, -10 removed lines

@@ -77,7 +77,7 @@ 
     }
 
     /**
-     * @return float
+     * @return integer|null
      */
     public function get_certificate_min_score()
     {
@@ -97,7 +97,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function get_parent_id()
     {
@@ -105,7 +105,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function get_weight()
     {
@@ -121,7 +121,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function is_visible()
     {
@@ -244,7 +244,7 @@ 
     }
 
     /**
-     * @return null
+     * @return null|integer
      */
     public function get_grade_model_id()
     {
@@ -487,7 +487,7 @@ 
     }
 
     /**
-     * @param $result
+     * @param Doctrine\DBAL\Driver\Statement|null $result
      *
      * @return array
      */
@@ -863,7 +863,8 @@ 
 
     /**
      * Calculate the score of this category
-     * @param $stud_id student id (default: all students - then the average is returned)
+     * @param integer $stud_id student id (default: all students - then the average is returned)
+     * @param integer $session_id
      * @return    array (score sum, weight sum)
      *             or null if no scores available
      */
@@ -1122,6 +1123,9 @@ 
      * @param int       student id
      * @param string    Course code
      * @param int       Session id
+     * @param integer $stud_id
+     * @param string $course_code
+     * @param integer $session_id
      */
     public function get_root_categories_for_student($stud_id, $course_code = null, $session_id = null)
     {
@@ -1202,6 +1206,9 @@ 
      * @param int user id (to return everything, use 'null' here)
      * @param string course code (optional)
      * @param int session id (optional)
+     * @param integer $user_id
+     * @param string $course_code
+     * @param integer $session_id
      */
     public function get_root_categories_for_teacher($user_id, $course_code = null, $session_id = null)
     {
@@ -1300,6 +1307,7 @@ 
 
     /**
      * Internal function used by get_target_categories()
+     * @param integer $level
      */
     private function add_target_subcategories($targets, $level, $catid)
     {
@@ -1399,6 +1407,8 @@ 
 
     /**
      * Internal function used by get_tree()
+     * @param integer $level
+     * @param null|integer $visible
      */
     private function add_subtree ($targets, $level, $catid, $visible)
     {
@@ -1416,6 +1426,7 @@ 
 
     /**
      * Generate an array of courses that a teacher hasn't created a category for.
+     * @param integer $user_id
      * @return array 2-dimensional array - every element contains 2 subelements (code, title)
      */
     public function get_not_created_course_categories ($user_id)
@@ -1450,6 +1461,7 @@ 
 
     /**
      * Generate an array of all courses that a teacher is admin of.
+     * @param integer $user_id
      * @return array 2-dimensional array - every element contains 2 subelements (code, title)
      */
     public function get_all_courses ($user_id)
@@ -1530,7 +1542,7 @@ 
     /**
      * Retrieve all categories inside a course independent category
      * that should be visible to a student.
-     * @param $cat_id parent category
+     * @param integer $cat_id parent category
      * @param $stud_id student id
      * @param $cats optional: if defined, the categories will be added to this array
      */
@@ -1851,7 +1863,7 @@ 
      * the platform administrator.
      * @param int locked 1 or unlocked 0
 
-     * @return bool
+     * @return boolean|null
      * */
     public function lock($locked)
     {
@@ -2282,7 +2294,7 @@ 
      * @param float $score The achieved score
      * @param int $userId The user id
      * @param int $categoryId The gradebook category
-     * @return int The insert id
+     * @return false|string The insert id
      */
     public static function registerCurrentScore($score, $userId, $categoryId)
     {