chamilo / chamilo-lms

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/blog.lib.php

Doc Comments +7 added lines, -11 removed lines

@@ -96,9 +96,7 @@ 
 	/**
 	 * Creates a new blog in the given course
 	 * @author Toon Keppens
-	 * @param Integer $course_id Id
 	 * @param String $title
-	 * @param Text $description
 	 */
 	public static function create_blog($title, $subtitle)
 	{
@@ -186,9 +184,7 @@ 
 	/**
 	 * Update title and subtitle of a blog in the given course
 	 * @author Toon Keppens
-	 * @param Integer $course_id Id
 	 * @param String $title
-	 * @param Text $description
 	 */
 	public static function edit_blog($blog_id, $title, $subtitle)
 	{
@@ -714,7 +710,6 @@ 
 	/**
 	 * Deletes an assigned task from a blog
 	 * @param Integer $blog_id
-	 * @param Integer $assignment_id
 	 */
 	public static function delete_assigned_task($blog_id, $task_id, $user_id)
 	{
@@ -1126,9 +1121,7 @@ 
 	 *
 	 * @param String $type
 	 * @param Integer $blog_id
-	 * @param Integer $item_id
-	 *
-	 *@return String
+	 * @param integer $post_id
 	 */
 	public static function display_rating_form ($type, $blog_id, $post_id, $comment_id = NULL)
 	{
@@ -2113,7 +2106,7 @@ 
 	 *
 	 * @param Integer $blog_id
 	 *
-	 * @return Html Form with sortable table with users to unsubcribe from a blog.
+	 * @return false|null Form with sortable table with users to unsubcribe from a blog.
 	 */
 	public static function display_form_user_unsubscribe ($blog_id)
 	{
@@ -2234,6 +2227,7 @@ 
 	 * @author Toon Keppens
 	 *
 	 * @param Integer $blog_id
+	 * @param integer $post_id
 	 */
 	public static function display_new_comment_form($blog_id, $post_id, $title)
 	{
@@ -2282,10 +2276,8 @@ 
 	 * @author Patrick Cool
 	 * @author Toon Keppens
 	 *
-	 * @param Array $blogitems an array containing all the blog items for the given month
 	 * @param Integer $month: the integer value of the month we are viewing
 	 * @param Integer $year: the 4-digit year indication e.g. 2005
-	 * @param String $monthName: the language variable for the mont name
 	 *
 	 * @return html code
 	*/
@@ -2579,6 +2571,7 @@ 
  * @param the blog's id
  * @param the post's id
  * @param the comment's id
+ * @param integer $blog_id
  * @return array with the post info according the parameters
  * @author Julio Montoya Dokeos
  * @version avril 2008, dokeos 1.8.5
@@ -2620,6 +2613,9 @@ 
  * @param the blog's id
  * @param the post's id
  * @param the comment's id
+ * @param integer $blog_id
+ * @param integer $post_id
+ * @param integer $comment_id
  * @author Julio Montoya Dokeos
  * @version avril 2008, dokeos 1.8.5
  */

main/inc/lib/browser/Browser.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
 
     /**
      * Set the name of the browser
-     * @param $browser string The name of the Browser
+     * @param string $browser string The name of the Browser
      */
     public function setBrowser($browser)
     {
@@ -266,7 +266,7 @@ 
 
     /**
      * Set the browser to be from AOL
-     * @param $isAol
+     * @param boolean $isAol
      */
     public function setAol($isAol)
     {

main/inc/lib/chat.lib.php

Doc Comments +2 added lines

@@ -41,6 +41,7 @@ 
     /**
     * Set user chat status
     * @param int 0 if disconnected, 1 if connected
+    * @param integer $status
      *
     * @return void
     */
@@ -164,6 +165,7 @@ 
     /**
      * Saves into session the fact that a chat window exists with the given user
      * @param int The ID of the user with whom the current user is chatting
+     * @param integer $user_id
      * @return void
      */
     public function save_window($user_id)

main/inc/lib/course_description.lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -95,7 +95,7 @@ 
      * Get all data by description and session id,
      * first you must set session_id property with the object CourseDescription
      * @param    int  $description_type Description type
-     * @param   string $course_code Course code (optional)
+     * @param   string $courseId Course code (optional)
      * @param    int $session_id Session id (optional)
      * @return array    List of fields from the descriptions found of the given type
      */
@@ -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()
     {

main/inc/lib/dashboard.lib.php

Doc Comments +1 added lines

@@ -493,6 +493,7 @@
 	 * This function update extra user blocks data after closing a dashboard block
 	 * @param int 		User id
 	 * @param string	plugin path
+	 * @param integer $user_id
 	 * @return bool
 	 */
 	public static function close_user_block($user_id, $path)

main/inc/lib/database.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -66,7 +66,7 @@ 
      *
      * @param string $table
      *
-     * @return mixed
+     * @return string
      */
     public static function get_main_table($table)
     {
@@ -265,7 +265,7 @@ 
 
     /**
      * Frees all the memory associated with the provided result identifier.
-     * @return bool     Returns TRUE on success or FALSE on failure.
+     * @return boolean|null     Returns TRUE on success or FALSE on failure.
      * Notes: Use this method if you are concerned about how much memory is being used for queries that return large result sets.
      * Anyway, all associated result memory is automatically freed at the end of the script's execution.
      */
@@ -381,7 +381,7 @@ 
      * @param array     $attributes
      * @param bool      $show_query
      *
-     * @return bool|int
+     * @return false|string
      */
     public static function insert($table_name, $attributes, $show_query = false)
     {

main/inc/lib/diagnoser.lib.php

Doc Comments +6 added lines

@@ -351,6 +351,12 @@
 
     /**
      * Additional functions needed for fast integration
+     * @param integer $status
+     * @param string $section
+     * @param string $title
+     * @param string $url
+     * @param string|null $formatter
+     * @param string $comment
      */
     public function build_setting($status, $section, $title, $url, $current_value, $expected_value, $formatter, $comment, $img_path = null) {
         switch ($status) {