chamilo / chamilo-lms

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/results_data_generator.class.php

Doc Comments +2 added lines

@@ -45,6 +45,7 @@ 
 
     /**
      * Get actual array data
+     * @param integer $count
      * @return array 2-dimensional array - each array contains the elements:
      * 0 ['id']        : user id
      * 1 ['result_id'] : result id
@@ -130,6 +131,7 @@ 
      * @param float Current absolute score (max score is taken from $this->evaluation->get_max()
      * @param bool  Whether we want the real score (2/4 (50 %)) or the transformation (A, B, C, etc)
      * @param bool  Whether we want to ignore the score color
+     * @param boolean $realscore
      * @result string The score as we want to show it
      */
     private function get_score_display ($score, $realscore, $ignore_score_color = false)

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

main/inc/ajax/admin.ajax.php

Doc Comments +2 added lines

@@ -189,6 +189,8 @@
  * @param float  Timeout
  * @param bool   Include HTTP Request headers?
  * @param bool   Include HTTP Response headers?
+ * @param string $ip
+ * @return string
  */
 function _http_request($ip, $port = 80, $uri = '/', $getdata = array(), $timeout = 5, $req_hdr = false, $res_hdr = false)
 {

main/inc/lib/access_url_edit_courses_to_url_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
      * a given string
      * @param string String to search for
      * @param int Deprecated param
-     * @return string A formatted, xajax answer block
+     * @return xajaxResponse A formatted, xajax answer block
      * @assert () === false
      */
     function search_courses($needle, $id)

main/inc/lib/access_url_edit_users_to_url_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      * search string
      * @param string Search string
      * @param int Deprecated param
-     * @return string Xajax response block
+     * @return xajaxResponse Xajax response block
      * @assert () === false
      */
     function search_users($needle, $id)

main/inc/lib/add_course.lib.inc.php

Doc Comments +4 added lines, -1 removed lines

@@ -189,7 +189,7 @@ 
 
     /**
      * Gets an array with all the course tables (deprecated?)
-     * @return array
+     * @return string[]
      * @assert (null) !== null
      */
     public static function get_course_tables()
@@ -310,6 +310,8 @@ 
      * @param string Complete path to directory we want to list
      * @param array A list of files to which we want to add the files found
      * @param string Type of base directory from which we want to recover the files
+     * @param string $path
+     * @param string $media
      * @return array
      * @assert (null,null,null) === false
      * @assert ('abc',array(),'') === array()
@@ -371,6 +373,7 @@ 
      * Sorts pictures by type (used?)
      * @param array List of files (sthg like array(0=>array('png'=>1)))
      * @param string File type
+     * @param string $type
      * @return array The received array without files not matching type
      * @assert (array(),null) === array()
      */