chamilo / chamilo-lms

main/gradebook/lib/fe/gradebooktable.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -32,6 +32,8 @@ 
      * @param array $evals
      * @param array $links
      * @param null $addparams
+     * @param boolean $showTeacherView
+     * @param integer $userId
      */
     public function __construct(
         $currentcat,
@@ -895,7 +897,7 @@ 
 
     /**
      * @param $item
-     * @return mixed
+     * @return string|null
      */
     private function build_course_code($item)
     {

main/gradebook/lib/fe/linkform.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -124,8 +124,8 @@
 	}
 
 	/**
-	 * @param $link
-	 * @param $courseCode
+	 * @param integer $link
+	 * @param null|string $courseCode
 	 * @return AttendanceLink|DropboxLink|ExerciseLink|ForumThreadLink|LearnpathLink|null|StudentPublicationLink|SurveyLink
 	 */
 	private function createLink($link, $courseCode)

main/gradebook/lib/flatview_data_generator.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -30,7 +30,7 @@ 
      * @param array $evals
      * @param array $links
      * @param array $params
-     * @param null $mainCourseCategory
+     * @param Category|null $mainCourseCategory
      */
     public function FlatViewDataGenerator(
         $users = array(),
@@ -276,6 +276,8 @@ 
 
     /**
      * Get actual array data
+     * @param integer $users_count
+     * @param integer $items_count
      * @return array 2-dimensional array - each array contains the elements:
      * 0: user id
      * 1: user lastname

main/gradebook/lib/gradebook_data_generator.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -71,6 +71,7 @@ 
 
     /**
      * Get actual array data
+     * @param integer $count
      * @return array 2-dimensional array - each array contains the elements:
      * 0: cat/eval/link object
      * 1: item name
@@ -304,7 +305,7 @@ 
     /**
      * @param int $userId
      * @param GradebookItem $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return null|string
      */
     private function build_result_column(

main/gradebook/lib/gradebook_result.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 
     /**
      * Exports the complete report as an XLS file
-     * @return	boolean		False on error
+     * @return	boolean|null		False on error
      */
     public function exportCompleteReportXLS($data)
     {

main/gradebook/lib/GradebookUtils.php

Doc Comments +7 added lines, -3 removed lines

@@ -19,6 +19,7 @@ 
      * @param   int     Visibility (0 hidden, 1 shown)
      * @param   int     Session ID (optional or 0 if not defined)
      * @param   int
+     * @param integer $resource_type
      * @return  boolean True on success, false on failure
      */
     public static function add_resource_to_course_gradebook(
@@ -117,7 +118,6 @@ 
 
     /**
      * Builds an img tag for a gradebook item
-     * @param string $type value returned by a gradebookitem's get_icon_name()
      */
     public static function build_type_icon_tag($kind, $attributes = array())
     {
@@ -382,6 +382,7 @@ 
      * @param    int     Resource type (use constants defined in linkfactory.class.php)
      * @param    int     Resource ID in the corresponding tool
      * @param    int     Session ID (optional -  0 if not defined)
+     * @param integer $resource_type
      * @return   int     false on error or array of resource
      */
     public static function is_resource_in_course_gradebook($course_code, $resource_type, $resource_id, $session_id = 0)
@@ -579,6 +580,9 @@ 
      * @param int The user id
      * @param float The score obtained for certified
      * @param Datetime The date when you obtained the certificate
+     * @param integer $cat_id
+     * @param integer $user_id
+     * @param string $date_certificate
      * @return void()
      */
     public static function register_user_info_about_certificate($cat_id, $user_id, $score_certificate, $date_certificate)
@@ -955,7 +959,7 @@ 
     }
 
     /**
-     * @param array $list_values
+     * @param string[] $list_values
      * @return string
      */
     public static function score_badges($list_values)
@@ -1015,7 +1019,7 @@ 
     }
 
     /**
-     * @param $result
+     * @param Doctrine\DBAL\Driver\Statement|null $result
      * @return array
      */
     public static function get_user_array_from_sql_result($result)

main/gradebook/lib/scoredisplay.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -232,7 +232,7 @@ 
 
     /**
      * @param int $category_id
-     * @return bool
+     * @return false|null
      */
     public function insert_defaults($category_id)
     {
@@ -263,7 +263,7 @@ 
     }
 
     /**
-     * @return int|null|string
+     * @return integer
      */
     public function get_number_decimals()
     {
@@ -337,8 +337,8 @@ 
 
     /**
      * @param $score
-     * @param $type
-     * @return float|string
+     * @param integer $type
+     * @return string
      */
     private function display_default($score, $type)
     {

main/gradebook/lib/user_data_generator.class.php

Doc Comments +5 added lines, -4 removed lines

@@ -72,6 +72,7 @@ 
 
 	/**
 	 * Get actual array data
+	 * @param integer $count
 	 * @return array 2-dimensional array - each array contains the elements:
 	 * 0: eval/link object
 	 * 1: item name
@@ -285,7 +286,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_average_column($item, $ignore_score_color)
@@ -306,7 +307,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_result_column($item, $ignore_score_color)
@@ -323,7 +324,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +340,7 @@ 
 
 	/**
 	 * @param $coursecode
-	 * @return mixed
+	 * @return string
 	 */
 	private function get_course_name_from_code_cached($coursecode)
 	{

main/group/group_space.php

Doc Comments +1 added lines, -1 removed lines

@@ -471,7 +471,7 @@
  * Display a user icon that links to the user page
  *
  * @param integer $user_id the id of the user
- * @return html code
+ * @return string code
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version April 2008