chamilo / chamilo-lms

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()
      */

main/inc/lib/add_courses_to_session_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
 	 * Searches a course, given a search string and a type of search box
 	 * @param string $needle Search string
 	 * @param string $type Type of search box ('single' or anything else)
-	 * @return string XajaxResponse
+	 * @return xajaxResponse XajaxResponse
 	 * @assert ('abc', 'single') !== null
 	 * @assert ('abc', 'multiple') !== null
 	 */

main/inc/lib/add_many_session_to_category_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
      * Search for a session based on a given search string
      * @param string A search string
      * @param string A search box type (single or anything else)
-     * @return string XajaxResponse
+     * @return xajaxResponse XajaxResponse
      * @assert () !== ''
      * @assert ('abc','single') !== ''
      */

main/inc/lib/AnnouncementEmail.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     /**
      *
      * @param int|array $course
-     * @param int|array $annoucement
+     * @param integer $announcement
      *
      * @return AnnouncementEmail
      */
@@ -50,7 +50,7 @@ 
      *
      * @param string $key
      *
-     * @return array
+     * @return string|null
      */
     public function course($key = '')
     {

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param $to_users
      * @param array $file
      * @param string $file_comment
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

main/inc/lib/app_view.php

Doc Comments +3 added lines

@@ -18,6 +18,7 @@ 
     /**
      * Constructor, init tool path for rendering
      * @param string  tool name (optional)
+     * @param string $template_path
      */
     public function __construct($toolname = '', $template_path=null)
     {
@@ -50,6 +51,7 @@ 
     /**
      * Set layout view sent from a controller
      * @param string layout view
+     * @param string $layout
      */
     public function set_layout( $layout )
     {
@@ -59,6 +61,7 @@ 
     /**
      * Set template view sent from a controller
      * @param string template view
+     * @param string $template
      */
     public function set_template($template)
     {

main/inc/lib/banner.lib.php

Doc Comments +6 added lines

@@ -147,6 +147,9 @@ 
     return $customTabs;
 }
 
+/**
+ * @param string $theme
+ */
 function return_logo($theme)
 {
     $_course = api_get_course_info();
@@ -497,6 +500,9 @@ 
     return $menu;
 }
 
+/**
+ * @param string $nameTools
+ */
 function return_breadcrumb($interbreadcrumb, $language_file, $nameTools)
 {
     $session_id = api_get_session_id();