chamilo / chamilo-lms

main/wiki/wiki.inc.php

Doc Comments +12 added lines, -4 removed lines

@@ -258,7 +258,7 @@ 
      * This function saves a change in a wiki page
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
      * @param array $values
-     * @return language string saying that the changes are stored
+     * @return string string saying that the changes are stored
      **/
     public function save_wiki($values)
     {
@@ -1196,6 +1196,7 @@ 
      * Checks if this navigation tab has to be set to active
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
      *
+     * @param string $paramwk
      * @return string html code
      */
     public function is_active_navigation_tab($paramwk)
@@ -1711,6 +1712,7 @@ 
 
     /**
      * Sends pending e-mails
+     * @param string $type
      */
     public function check_emailcue($id_or_ref, $type, $lastime='', $lastuser='')
     {
@@ -2011,6 +2013,7 @@ 
 
     /**
      * Exports the wiki page to PDF
+     * @param string $course_code
      */
     public function export_to_pdf($id, $course_code)
     {
@@ -2478,6 +2481,7 @@ 
     /**
      * Draws an HTML form select with the given options
      *
+     * @param string $name
      */
     public function make_select($name,$values,$checked='')
     {
@@ -2514,7 +2518,7 @@ 
     /**
      * Get wiki information
      * @param   int|bool     wiki id
-     * @return  array   wiki data
+     * @return  string   wiki data
      */
     public function getWikiDataFromDb($id)
     {
@@ -2561,6 +2565,7 @@ 
      * Get wiki information
      * @param   string     wiki id
      * @param int $courseId
+     * @param string $title
      * @return  array   wiki data
      */
     public function getPageByTitle($title, $courseId = null)
@@ -2593,6 +2598,8 @@ 
      * @param int $courseId
      * @param string
      * @param string
+     * @param string $groupfilter
+     * @param string $condition_session
      * @return bool
      */
     public function deletePage($title, $courseId, $groupfilter = null, $condition_session = null)
@@ -3644,6 +3651,7 @@ 
 
     /**
      * Show all pages
+     * @param string $action
      */
     public function allPages($action)
     {
@@ -4200,7 +4208,7 @@ 
 
     /**
      * Restore page
-     * @return bool
+     * @return false|null
      */
     public function restorePage()
     {
@@ -4302,7 +4310,7 @@ 
     }
 
     /**
-     * @param int|bool $wikiId
+     * @param false|string $wikiId
      */
     public function setWikiData($wikiId)
     {

main/inc/lib/CourseChatUtils.php

Doc Comments +2 added lines, -2 removed lines

@@ -1415,7 +1415,7 @@ 
 
     /**
      * Get the emoji list to include in chat
-     * @return array
+     * @return string[]
      */
     public static function getEmojisToInclude()
     {
@@ -1738,7 +1738,7 @@ 
 
     /**
      * Get the number of users connected in chat
-     * @return mixed
+     * @return integer
      */
     public function countUsersOnline()
     {

main/gradebook/lib/GradebookUtils.php

Doc Comments +1 added lines, -1 removed lines

@@ -732,7 +732,7 @@
     }
 
     /**
-     * @param null $course_code
+     * @param string $course_code
      * @param int $gradebook_model_id
      * @return mixed
      */

main/inc/lib/glossary.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -95,7 +95,7 @@ 
      *
      * @param array  $values  Array of title + description (name => $title, description => $comment)
      *
-     * @return mixed   Term id on success, false on failure
+     * @return false|string   Term id on success, false on failure
      *
      */
     public static function save_glossary($values, $showMessage = true)
@@ -448,7 +448,7 @@ 
 
     /**
      * Display the glossary terms in a list
-     * @return bool true
+     * @return string true
      */
     public static function displayGlossaryList()
     {
@@ -585,7 +585,7 @@ 
      * Update action icons column
      *
      * @param integer $glossary_id
-     * @param array   $url_params Parameters to use to affect links
+     * @param string   $url_params Parameters to use to affect links
      * @param array   $row The line of results from a query on the glossary table
      *
      * @return string HTML string for the action icons columns

main/inc/lib/extra_field.lib.php

Doc Comments +7 added lines, -7 removed lines

@@ -140,7 +140,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getValidExtraFieldTypes()
     {
@@ -217,7 +217,7 @@ 
 
     /**
      * @param array $conditions
-     * @param null  $order_field_options_by
+     * @param string  $order_field_options_by
      *
      * @return array
      */
@@ -375,7 +375,7 @@ 
     /**
      * @param string $handler
      *
-     * @return array
+     * @return string[]
      */
     public static function get_extra_fields_by_handler($handler)
     {
@@ -574,7 +574,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_field_types()
     {
@@ -584,7 +584,7 @@ 
     /**
      * @param int $id
      *
-     * @return null
+     * @return string|null
      */
     public function get_field_type_by_id($id)
     {
@@ -1826,7 +1826,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getJqgridColumnNames()
     {
@@ -2086,7 +2086,7 @@ 
     }
 
     /**
-     * @param array $columns
+     * @param string[] $columns
      * @param array  $column_model
      * @param array  $extraFields
      * @return array

app/check.php

Doc Comments +3 added lines

@@ -96,6 +96,9 @@
     echo PHP_EOL;
 }
 
+/**
+ * @param string $message
+ */
 function echo_style($style, $message)
 {
     // ANSI color codes

main/inc/lib/auth.lib.php

Doc Comments +8 added lines

@@ -183,6 +183,7 @@ 
      * (moving a course to a different course category)
      * @param  int    $courseId
      * @param  int       Category id
+     * @param integer $newcategory
      * @return bool      True if it success
      */
     public function updateCourseCategory($courseId, $newcategory)
@@ -215,6 +216,9 @@ 
      * @param   string    Direction (up/down)
      * @param   string    Course code
      * @param   int       Category id
+     * @param string $direction
+     * @param string $course2move
+     * @param integer $category
      * @return  bool      True if it success
      */
     public function move_course($direction, $course2move, $category)
@@ -285,6 +289,8 @@ 
      * Moves the course one place up or down
      * @param string    Direction up/down
      * @param string    Category id
+     * @param string $direction
+     * @param integer $category2move
      * @return bool     True If it success
      */
     public function move_category($direction, $category2move)
@@ -348,6 +354,8 @@ 
      * Updates the user course category in the chamilo_user database
      * @param   string  Category title
      * @param   int     Category id
+     * @param string $title
+     * @param integer $category_id
      * @return  bool    True if it success
      */
     public function store_edit_course_category($title, $category_id)

main/inc/lib/blog.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -1103,7 +1103,7 @@
      * @param String $type
      * @param Integer $blog_id
      * @param Integer $item_id
-     * @return array
+     * @return double
      */
     public static function display_rating($type, $blog_id, $item_id)
     {

main/inc/lib/course_description.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -359,7 +359,7 @@ 
 
     /**
      * Get description titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_title()
     {
@@ -378,7 +378,7 @@ 
 
     /**
      * Get description titles editable by default
-     * @return array
+     * @return boolean[]
      */
     public function get_default_description_title_editable()
     {
@@ -397,7 +397,7 @@ 
 
     /**
      * Get description icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_icon()
     {
@@ -417,7 +417,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {
@@ -436,7 +436,7 @@ 
 
     /**
      * Get informations by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_information()
     {
@@ -574,7 +574,7 @@ 
     /**
      * get progress of a description
      *
-     * @return int
+     * @return string
      */
     public function get_progress()
     {