chamilo / chamilo-lms

main/inc/lib/display.lib.php

Doc Comments +26 added lines, -17 removed lines

@@ -33,7 +33,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -293,7 +293,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show.
      * i.e: $visibility_options= array(true, false) we will only show the first column
      * 				Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -334,7 +333,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show. i.e:
      *  $visibility_options= array(true, false) we will only show the first column
      * 	Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -391,10 +389,11 @@ 
      * 					'per_page' = number of items to show per page
      * 					'page_nr' = The page to display
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $column_show Array of binaries 1= show columns 0. hide a column
+     * @param integer[] $column_show Array of binaries 1= show columns 0. hide a column
      * @param array $column_order An array of integers that let us decide how the columns are going to be sort.
      * 						      i.e:  $column_order=array('1''4','3','4'); The 2nd column will be order like the 4th column
      * @param array $form_actions Set optional forms actions
+     * @param string $table_name
      *
      * @author Julio Montoya
      */
@@ -449,7 +448,7 @@ 
      *
      * @deprecated use Display::addFlash with Display::return_message($message, 'normal');
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
@@ -481,7 +480,7 @@ 
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool	Filter (true) or not (false)
      * @deprecated use Display::addFlash with Display::return_message
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
     {
@@ -500,7 +499,7 @@ 
      * @param bool	Filter (true) or not (false)
      * @deprecated use Display::addFlash with Display::return_message
      *
-     * @return void
+     * @return string|null
      */
     public static function display_error_message ($message, $filter = true, $returnValue = false)
     {
@@ -681,6 +680,7 @@ 
      * @param string   The alt text (probably a language variable)
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
+     * @param string $image
      * @return void
     */
     public static function display_icon(
@@ -917,6 +917,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -933,8 +934,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -949,6 +950,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -1015,8 +1017,8 @@ 
                         $( "#tabs" ).tabs();
                     });
                 </script>
-     * @param   array   $headers list of the tab titles
-     * @param   array   $items
+     * @param   string[]   $headers list of the tab titles
+     * @param   string[]   $items
      * @param   string  $id id of the container of the tab in the example "tabs"
      * @param   array   $attributes for the ul
      * @param array $ul_attributes
@@ -1070,7 +1072,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1108,6 +1110,7 @@ 
      * As you can see both function use the same "my_grid_name" this is very important otherwise nothing will work
      *
      * @param   string  the div id, this value must be the same with the first parameter of Display::grid_js()
+     * @param string $div_id
      * @return  string  html
      *
      */
@@ -1668,6 +1671,8 @@ 
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
 	 * @param	string	point info array see function CourseManager::get_course_ranking()
 	 * @param	bool	add a div wrapper
+	 * @param string $id
+	 * @param string $url
 	 * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
@@ -1758,6 +1763,9 @@ 
         return '<'.$size.'>'.Security::remove_XSS($title).'</'.$size.'>';
     }
 
+    /**
+     * @param string $title
+     */
     public static function page_subheader2($title, $second_title = null)
     {
         return self::page_header($title, $second_title, 'h4');
@@ -2005,6 +2013,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function groupButtonWithDropDown($title, $elements)
     {
@@ -2378,9 +2387,9 @@ 
 
     /**
      * @param int $id
-     * @param array $content
+     * @param string[] $content
      * @param int $col
-     * @param bool|true $right
+     * @param boolean $right
      * @return string
      */
     public static function toolbarAction($id, $content = array(), $col = 2, $right = true)
@@ -2464,10 +2473,10 @@ 
     /**
      * @param string $title
      * @param string $content
-     * @param null $id
+     * @param string $id
      * @param array $params
-     * @param null $idAccordion
-     * @param null $idCollapse
+     * @param string $idAccordion
+     * @param string $idCollapse
      * @param bool|true $open
      * @param bool|false $fullClickable
      * @return null|string

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

Doc Comments +4 added lines, -1 removed lines

@@ -120,6 +120,9 @@ 
 		return $this->created_at;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function get_weight()
 	{
 		return $this->weight;
@@ -271,7 +274,7 @@ 
 	}
 
 	/**
-	 * @param array $result
+	 * @param Doctrine\DBAL\Driver\Statement|null $result
 	 * @return array
 	 */
 	private static function create_evaluation_objects_from_sql_result($result)

main/gradebook/lib/scoredisplay.class.php

Doc Comments +3 added lines, -3 removed lines

@@ -277,7 +277,7 @@ 
      * Formats a number depending of the number of decimals
      *
      * @param float $score
-     * @return float the score formatted
+     * @return boolean|string the score formatted
      */
     public function format_score($score)
     {
@@ -391,7 +391,7 @@ 
 
     /**
      * @param array $score
-     * @return float|string
+     * @return boolean|string
      */
     private function display_simple_score($score)
     {
@@ -404,7 +404,7 @@ 
     /**
      * Returns "1" for array("100", "100");
      * @param array $score
-     * @return float
+     * @return boolean|string
      */
     private function display_as_decimal($score)
     {

main/exercise/export/exercise_import.inc.php

Doc Comments -1 removed lines

@@ -1022,7 +1022,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)