chamilo / chamilo-lms

main/inc/lib/career.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
     /**
      * Available driver list.
-     * @return array
+     * @return string[]
      */
     private function getDefaultDriverList()
     {

main/inc/lib/api.lib.php

Doc Comments +52 added lines, -25 removed lines

@@ -575,7 +575,6 @@ 
  * Also, this function provides conversion between path types, in this case the input path points inside the Chamilo area too.
  *
  * See $_configuration['course_folder'] in the configuration.php to alter the WEB_COURSE_PATH and SYS_COURSE_PATH parameters.
- * @param string $type              The requested path type (a defined constant), see the examples.
  * @param string $path (optional)   A path which type is to be converted. Also, it may be a defined constant for a path.
  * This parameter has meaning when $type parameter has one of the following values: TO_WEB, TO_SYS, TO_REL. Otherwise it is ignored.
  * @return string                   The requested path or the converted path.
@@ -1070,7 +1069,7 @@ 
  * Checks the RFC 3986 syntax of a given URL.
  * @param string $url       The URL to be checked.
  * @param bool $absolute    Whether the URL is absolute (beginning with a scheme such as "http:").
- * @return bool             Returns the URL if it is valid, FALSE otherwise.
+ * @return string|false             Returns the URL if it is valid, FALSE otherwise.
  * This function is an adaptation from the function valid_url(), Drupal CMS.
  * @link http://drupal.org
  * Note: The built-in function filter_var($urs, FILTER_VALIDATE_URL) has a bug for some versions of PHP.
@@ -1650,6 +1649,7 @@ 
  * Gets a course setting from the current course_setting table. Try always using integer values.
  * @param string    The name of the setting we want from the table
  * @param string    Optional: course code
+ * @param string $setting_name
  * @return mixed    The value of that setting in that table. Return -1 if not found.
  */
 function api_get_course_setting($setting_name, $course_code = null)
@@ -1957,7 +1957,7 @@ 
 /**
  * Checks a password to see wether it is OK to use.
  * @param string $password
- * @return true if the password is acceptable, false otherwise
+ * @return boolean if the password is acceptable, false otherwise
  * Notes about what a password "OK to use" is:
  * 1. The password should be at least 5 characters long.
  * 2. Only English letters (uppercase or lowercase, it doesn't matter) and digits are allowed.
@@ -2129,7 +2129,7 @@ 
      * @author Hugues Peeters <peeters@ipm.ucl.ac.be>
      * @param  string $failure_type - the type of failure
      * @global array  $api_failureList
-     * @return bolean false to stay consistent with the main script
+     * @return boolean false to stay consistent with the main script
      */
     static function set_failure($failure_type) {
         global $api_failureList;
@@ -3196,8 +3196,8 @@ 
 
 /**
 * Checks whether the user is allowed in a specific tool for a specific action
-* @param $tool the tool we are checking if the user has a certain permission
-* @param $action the action we are checking (add, edit, delete, move, visibility)
+* @param string $tool the tool we are checking if the user has a certain permission
+* @param string $action the action we are checking (add, edit, delete, move, visibility)
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @author Julio Montoya
 * @version 1.0
@@ -3496,7 +3496,7 @@ 
 /**
  * Gets a UNIX timestamp from a database (MySQL) datetime format string
  * @param $last_post_datetime standard output date in a sql query
- * @return unix timestamp
+ * @return integer timestamp
  * @author Toon Van Hoecke <Toon.VanHoecke@UGent.be>
  * @version October 2003
  * @desc convert sql date to unix timestamp
@@ -3529,6 +3529,9 @@ 
  * @param string    Tool (learnpath, document, etc)
  * @param int       The item ID in the given tool
  * @param int       The session ID (optional)
+ * @param string $tool
+ * @param integer $user_id
+ * @param string $type
  * @return int      -1 on error, 0 if invisible, 1 if visible
  */
 function api_get_item_visibility(
@@ -3597,7 +3600,7 @@ 
  * @param int $userId
  * @param int $groupId
  * @param int $sessionId
- * @return void
+ * @return false|null
  */
 function api_item_property_delete(
     $courseInfo,
@@ -3652,7 +3655,7 @@ 
  * @param array $_course array with course properties
  * @param string $tool tool id, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  * @param int $item_id id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
- * @param string $lastedit_type add or update action
+ * @param string $last_edit_type add or update action
  * (1) message to be translated (in trad4all) : e.g. DocumentAdded, DocumentUpdated;
  * (2) "delete"
  * (3) "visible"
@@ -3935,6 +3938,8 @@ 
  * @param string    tool name, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  * @param int       id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
  * @param int $session_id
+ * @param string $tool
+ * @param string $course_code
  * @return array All fields from c_item_property (all rows found) or empty array
  */
 function api_get_item_property_by_tool($tool, $course_code, $session_id = null)
@@ -4197,7 +4202,7 @@ 
  * Displays a form (drop down menu) so the user can select his/her preferred language.
  * The form works with or without javascript
  * @param  boolean Hide form if only one language available (defaults to false = show the box anyway)
- * @return void Display the box directly
+ * @return null|string Display the box directly
  */
 function api_display_language_form($hide_if_no_choice = false)
 {
@@ -4477,6 +4482,7 @@ 
  * and also when a user subscribes to courses (the new course is added at the end of the main category
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $user_course_category: the id of the user_course_category
+ * @param integer $user_id
  * @return int the value of the highest sort of the user_course_category
  */
 function api_max_sort_value($user_course_category, $user_id)
@@ -4685,6 +4691,8 @@ 
  * @param the dest folder
  * @param an array of excluded file_name (without extension)
  * @param copied_files the returned array of copied files
+ * @param string $source
+ * @param string $dest
  */
 function copyr($source, $dest, $exclude = array(), $copied_files = array()) {
     if (empty($dest)) { return false; }
@@ -4724,6 +4732,11 @@ 
 }
 
 // TODO: Using DIRECTORY_SEPARATOR is not recommended, this is an obsolete approach. Documentation header to be added here.
+/**
+ * @param string $pathname
+ * @param string $base_path_document
+ * @param integer $session_id
+ */
 function copy_folder_course_session(
     $pathname,
     $base_path_document,
@@ -4809,6 +4822,9 @@ 
 }
 
 // TODO: chmodr() is a better name. Some corrections are needed. Documentation header to be added here.
+/**
+ * @param string $path
+ */
 function api_chmod_R($path, $filemode) {
     if (!is_dir($path)) {
         return chmod($path, $filemode);
@@ -4891,7 +4907,7 @@ 
  *   version = VERSION
  * @endverbatim
  * </code>
- * @param $filename
+ * @param string $filename
  *   The file we are parsing. Accepts file with relative or absolute path.
  * @return
  *   The info array.
@@ -4983,7 +4999,7 @@ 
 /**
  * Checks whether status given in parameter exists in the platform
  * @param mixed the status (can be either int either string)
- * @return true if the status exists, else returns false
+ * @return boolean if the status exists, else returns false
  */
 function api_status_exists($status_asked) {
     global $_status_list;
@@ -5005,7 +5021,7 @@ 
 
 /**
  * Gets the status langvars list
- * @return array the list of status with their translations
+ * @return string[] the list of status with their translations
  */
 function api_get_status_langvars() {
     return array(
@@ -5081,6 +5097,7 @@ 
  * @param string    The sub-variable if any (in most cases, this will remain null)
  * @param string    The category if any (in most cases, this will remain null)
  * @param int       The access_url for which this parameter is valid
+ * @param string $cat
  */
 function api_set_setting($var, $value, $subvar = null, $cat = null, $access_url = 1)
 {
@@ -5178,6 +5195,8 @@ 
  * @param string    Value
  * @param int       Access URL. Optional. Defaults to 1
  * @param array     Optional array of filters on field type
+ * @param string $category
+ * @param string $value
  */
 function api_set_settings_category($category, $value = null, $access_url = 1, $fieldtype = array())
 {
@@ -5421,6 +5440,10 @@ 
  * @param string    The subkey text
  * @param int       The access_url for which this parameter is valid
  * @param int       The changeability of this setting for non-master urls
+ * @param string $val
+ * @param string $var
+ * @param string $sk
+ * @param string $c
  * @return boolean  true on success, false on failure
  */
 function api_add_setting($val, $var, $sk = null, $type = 'textfield', $c = null, $title = '', $com = '', $sc = null, $skt = null, $a = 1, $v = 0) {
@@ -5686,6 +5709,7 @@ 
  * @param String the tool of the element
  * @param int the element id in database
  * @param int the session_id to compare with element session id
+ * @param string $tool
  * @return boolean true if the element is in the session, false else
  */
 function api_is_element_in_the_session($tool, $element_id, $session_id = null) {
@@ -5731,8 +5755,6 @@ 
  * Replaces "forbidden" characters in a filename string.
  *
  * @param string $filename
- * @param int $length
- * @param bool $file_name
  *
  * @return string
  */
@@ -5968,6 +5990,7 @@ 
  * @link http://php.net/manual/en/function.getimagesize.php
  * @link http://www.dokeos.com/forum/viewtopic.php?t=12345
  * @link http://www.dokeos.com/forum/viewtopic.php?t=16355
+ * @return integer
  */
 function api_getimagesize($path) {
     $image = new Image($path);
@@ -6128,6 +6151,7 @@ 
  * with his user id and the access_url_id=1
  *
  * @author Julio Montoya
+ * @param integer $user_id
  */
 function api_is_global_platform_admin($user_id = null)
 {
@@ -6189,7 +6213,7 @@ 
  * @param int $admin_id_to_check
  * @param int  $my_user_id
  * @param bool $allow_session_admin
- * @return bool
+ * @return boolean|null
  */
 function api_protect_super_admin($admin_id_to_check, $my_user_id = null, $allow_session_admin = false)
 {
@@ -6431,6 +6455,7 @@ 
 
 /**
  * Returns the <link> HTML tag
+ * @param string $file
  */
 function api_get_css($file, $media = 'screen') {
     return '<link href="'.$file.'" rel="stylesheet" media="'.$media.'" type="text/css" />'."\n";
@@ -6568,7 +6593,8 @@ 
  * This function relies on api_get_course_info()
  * @param   string  The course code - optional (takes it from session if not given)
  * @param   int     The session id  - optional (takes it from session if not given)
- * @return  mixed   The URL of the course or null if something does not work
+ * @param integer $session_id
+ * @return  string|null   The URL of the course or null if something does not work
  * @author  Julio Montoya <gugli100@gmail.com>
  */
 function api_get_course_url($course_code = null, $session_id = null)
@@ -6683,7 +6709,7 @@ 
  * @param int       LINK_EXERCISE, LINK_STUDENTPUBLICATION, LINK_LEARNPATH LINK_FORUM_THREAD, LINK_ATTENDANCE
  * see gradebook/lib/be/linkfactory
  * @param string    course code
- * @return boolean
+ * @return false|null
  */
 function api_block_course_item_locked_by_gradebook($item_id, $link_type, $course_code = null) {
     if (api_is_platform_admin()) {
@@ -6724,7 +6750,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6767,7 +6793,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
- * @return mixed Integer User ID is logged in, or false otherwise
+ * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
     $user_id = empty($user_id) ? api_get_user_id() : intval($user_id);
@@ -6802,6 +6828,7 @@ 
  * Checks whether an IP is included inside an IP range
  * @param string IP address
  * @param string IP range
+ * @param string $ip
  * @return bool True if IP is in the range, false otherwise
  * @author claudiu at cnixs dot com  on http://www.php.net/manual/fr/ref.network.php#55230
  * @author Yannick Warnier for improvements and managment of multiple ranges
@@ -7185,6 +7212,7 @@ 
 /**
  * Tries to set memory limit, if authorized and new limit is higher than current
  * @param string New memory limit
+ * @param string $mem
  * @return bool True on success, false on failure or current is higher than suggested
  * @assert (null) === false
  * @assert (-1) === false
@@ -7241,7 +7269,6 @@ 
 
 /**
  * Finds all the information about a user from username instead of user id
- * @param string $username
  *
  * @return array $user_info user_id, lastname, firstname, username, email, ...
  * @author Yannick Warnier <yannick.warnier@beeznest.com>
@@ -7263,7 +7290,6 @@ 
 
 /**
  *
- * @param string $inputId the jquery id example: #password
  *
  * @return string
  */
@@ -7388,6 +7414,7 @@ 
 /**
  * Remove tags from HTML anf return the $in_number_char first non-HTML char
  * Postfix the text with "..." if it has been truncated.
+ * @param integer $in_number_char
  * @return string
  * @author hubert borderiou
  */
@@ -7432,7 +7459,7 @@ 
 /**
  * @param string $tool
  * @param string $setting
- * @param mixed $defaultValue
+ * @param integer $defaultValue
  * @return string
  */
 function api_get_default_tool_setting($tool, $setting, $defaultValue)
@@ -7557,7 +7584,7 @@ 
 }
 
 /**
- * @return true if course_code for direct course access after login is set
+ * @return boolean if course_code for direct course access after login is set
  */
 function exist_firstpage_parameter()
 {
@@ -7849,7 +7876,7 @@ 
  * @param array     data file (path and filename)
  * @param array     data to attach a file (optional)
  * @param bool      True for attaching a embedded file inside content html (optional)
- * @return          returns true if mail was sent
+ * @return          integer true if mail was sent
  * @see             class.phpmailer.php
  */
 function api_mail_html(

main/inc/lib/message.lib.php

Doc Comments +7 added lines, -5 removed lines

@@ -639,6 +639,8 @@ 
      * @param  int	message id
      * @param  int	message user id (receiver user id or sender user id)
      * @param  int	group id (optional)
+     * @param integer $message_id
+     * @param integer $message_uid
      * @return void
      */
     public static function delete_message_attachment_file($message_id, $message_uid, $group_id = 0)
@@ -683,7 +685,7 @@ 
      * update messages by user id and message id
      * @param  int		$user_id
      * @param  int		$message_id
-     * @return resource
+     * @return false|null
      */
     public static function update_message($user_id, $message_id)
     {
@@ -703,7 +705,7 @@ 
      * @param int $user_id
      * @param int $message_id
      * @param string $type
-     * @return bool
+     * @return false|null
      */
     public static function update_message_status($user_id, $message_id,$type)
     {
@@ -740,6 +742,7 @@ 
     /**
      * get messages by group id
      * @param  int		group id
+     * @param integer $group_id
      * @return array
      */
     public static function get_messages_by_group($group_id)
@@ -1477,7 +1480,7 @@ 
      * Sort date by desc from a multi-dimensional array
      * @param array $array1  first array to compare
      * @param array $array2  second array to compare
-     * @return bool
+     * @return integer
      */
     public function order_desc_date($array1, $array2)
     {
@@ -1555,7 +1558,6 @@ 
     /**
      * @param $id
      * @param array $params
-     * @param string $display
      * @return string
      */
     public static function generate_invitation_form($id, $params = array())
@@ -1644,7 +1646,7 @@ 
 
     /**
      * @param string $keyword
-     * @return null|string
+     * @return string
      */
     public static function outbox_display($keyword = '')
     {

main/inc/lib/agenda.lib.php

Doc Comments +8 added lines, -3 removed lines

@@ -565,7 +565,7 @@ 
      * @param string $color
      * @param bool $addAnnouncement
      *
-     * @return bool
+     * @return null|false
      */
     public function editEvent(
         $id,
@@ -1308,6 +1308,7 @@ 
      *
      * @param int $eventId
      * @param int $courseId
+     * @param integer $sessionId
      * @paraù int $sessionId
      *
      * @return array
@@ -2469,6 +2470,7 @@ 
      * Adds x weeks to a UNIX timestamp
      * @param   int     The timestamp
      * @param   int     The number of weeks to add
+     * @param integer $timestamp
      * @return  int     The new timestamp
      */
     function addWeek($timestamp, $num = 1)
@@ -2480,6 +2482,7 @@ 
      * Adds x months to a UNIX timestamp
      * @param   int     The timestamp
      * @param   int     The number of years to add
+     * @param integer $timestamp
      * @return  int     The new timestamp
      */
     function addMonth($timestamp, $num = 1)
@@ -2498,6 +2501,7 @@ 
      * Adds x years to a UNIX timestamp
      * @param   int     The timestamp
      * @param   int     The number of years to add
+     * @param integer $timestamp
      * @return  int     The new timestamp
      */
     function addYear($timestamp, $num = 1)
@@ -2697,7 +2701,7 @@ 
     /**
      * @param array $courseInfo
      * @param $file
-     * @return array|bool|string
+     * @return false|string
      */
     public function importEventFile($courseInfo, $file)
     {
@@ -2810,7 +2814,7 @@ 
 
     /**
      * Parse filter turns USER:12 to ['users' => [12])] or G:1 ['groups' => [1]]
-     * @param $filter
+     * @param integer $filter
      * @return array
      */
     public function parseAgendaFilter($filter)
@@ -3324,6 +3328,7 @@ 
      * @param	int		user ID of the user
      * @param	string	Optional start date in datetime format (if no start date is given, uses today)
      * @param	string	Optional end date in datetime format (if no date is given, uses one year from now)
+     * @param integer $user_id
      * @return	array	Array of events ordered by start date, in
      * [0]('datestart','dateend','title'),[1]('datestart','dateend','title','link','coursetitle') format,
      * where datestart and dateend are in yyyyMMddhhmmss format.

main/inc/lib/sessionmanager.lib.php

Doc Comments +24 added lines, -19 removed lines

@@ -1336,9 +1336,9 @@ 
      * @param integer   $sessionCategoryId
      * @param int       $visibility
      * @param string    $description
-     * @param bool      $showDescription
+     * @param integer      $showDescription
      * @param int       $duration
-     * @param array     $extraFields
+     * @param boolean|null     $extraFields
      * @param int       $sessionAdminId
      * @param boolean $sendSubscriptionNotification Optional.
      *          Whether send a mail notification to users being subscribed
@@ -1558,7 +1558,7 @@ 
      * @param array $user_list
      * @param int $session_visibility
      * @param bool $empty_users
-     * @return bool
+     * @return false|null
      */
     public static function suscribe_users_to_session(
         $id_session,
@@ -1830,7 +1830,7 @@ 
      * @param array $courseInfo
      * @param int $status
      * @param bool $updateTotal
-     * @return bool
+     * @return false|null
      */
     public static function removeUsersFromCourseSession(
         $userList,
@@ -1896,7 +1896,7 @@ 
      * @param string $course_code
      * @param int $session_visibility
      * @param bool $removeUsersNotInList
-     * @return bool
+     * @return false|null
      */
     public static function subscribe_users_to_session_course(
         $user_list,
@@ -2079,7 +2079,7 @@ 
      * @param	bool	$removeExistingCoursesWithUsers Whether to unsubscribe
      * existing courses and users (true, default) or not (false)
      * @param $copyEvaluation from base course to session course
-     * @return	void	Nothing, or false on error
+     * @return	false|null	Nothing, or false on error
      * */
     public static function add_courses_to_session(
         $sessionId,
@@ -2275,6 +2275,8 @@ 
      *
      * @param int Session id
      * @param int Course id
+     * @param integer $session_id
+     * @param integer $course_id
      * @return bool True in case of success, false otherwise
      */
     public static function unsubscribe_course_from_session($session_id, $course_id)
@@ -2330,7 +2332,7 @@ 
      * @param	string	$variable Field's internal variable name
      * @param	int		$fieldType Field's type
      * @param	string	$displayText Field's language var name
-     * @return int     new extra field id
+     * @return boolean     new extra field id
      */
     public static function create_session_extra_field($variable, $fieldType, $displayText)
     {
@@ -2349,7 +2351,7 @@ 
      * @param	integer	Course ID
      * @param	string	Field variable name
      * @param	string	Field value
-     * @return	boolean	true if field updated, false otherwise
+     * @return	boolean|null	true if field updated, false otherwise
      */
     public static function update_session_extra_field_value($sessionId, $variable, $value = '')
     {
@@ -2554,7 +2556,7 @@ 
      * @param	array	id_checked
      * @param	bool	include delete session
      * @param	bool	optional, true if the function is called by a webservice, false otherwise.
-     * @return	void	Nothing, or false on error
+     * @return	boolean	Nothing, or false on error
      * The parameters is a array to delete sessions
      * */
     public static function delete_session_category($id_checked, $delete_session = false, $from_ws = false)
@@ -3049,6 +3051,7 @@ 
      * @param string $orderCondition
      * @param string $keyword
      * @param string $description
+     * @param integer $status
      * @return array sessions
      */
     public static function getSessionsFollowedByUser(
@@ -3261,8 +3264,8 @@ 
     /**
      * Gets the list of courses by session filtered by access_url
      *
-     * @param $userId
-     * @param $sessionId
+     * @param integer $userId
+     * @param null|integer $sessionId
      * @param null $from
      * @param null $limit
      * @param null $column
@@ -3387,6 +3390,7 @@ 
     /**
      * Gets the count of courses by session filtered by access_url
      * @param int session id
+     * @param integer $session_id
      * @return array list of courses
      */
     public static function getCourseCountBySessionId($session_id, $keyword = null)
@@ -3638,6 +3642,7 @@ 
      * Updates a session status
      * @param	int 	session id
      * @param	int 	status
+     * @param integer $status
      */
     public static function set_session_status($session_id, $status)
     {
@@ -3949,7 +3954,7 @@ 
 
     /**
      * @param $id
-     * @return bool
+     * @return null|boolean
      */
     public static function protect_teacher_session_edit($id)
     {
@@ -4013,7 +4018,7 @@ 
      *  true: if the session exists it will be updated.
      *  false: if session exists a new session will be created adding a counter session1, session2, etc
      * @param int $defaultUserId
-     * @param mixed $logger
+     * @param Logger $logger
      * @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID then it will
      * converted to extra_external_session_id if you set this: array('SessionId' => 'extra_external_session_id')
      * @param string $extraFieldId
@@ -5255,7 +5260,6 @@ 
      * @param string $lastConnectionDate
      * @param array $sessionIdList
      * @param array $studentIdList
-     * @param int $userStatus STUDENT|COURSEMANAGER constants
      *
      * @return array|int
      */
@@ -5407,7 +5411,7 @@ 
     /**
      * Get the list of course tools that have to be dealt with in case of
      * registering any course to a session
-     * @return array The list of tools to be dealt with (literal names)
+     * @return string[] The list of tools to be dealt with (literal names)
      */
     public static function getCourseToolToBeManaged()
     {
@@ -5421,7 +5425,7 @@ 
      * Calls the methods bound to each tool when a course is registered into a session
      * @param int $sessionId
      * @param int $courseId
-     * @return void
+     * @return boolean|null
      */
     public static function installCourse($sessionId, $courseId)
     {
@@ -6061,6 +6065,7 @@ 
      * @param int $categoryId The internal ID of the session category
      * @param string $target Value to search for in the session field values
      * @param array $extraFields A list of fields to be scanned and returned
+     * @param DateTime $publicationDate
      * @return mixed
      */
     public static function getShortSessionListAndExtraByCategory($categoryId, $target, $extraFields = null, $publicationDate = null)
@@ -7390,7 +7395,7 @@ 
     /**
      * Get link to the admin page for this session
      * @param   int $id Session ID
-     * @return mixed    URL to the admin page to manage the session, or false on error
+     * @return false|string    URL to the admin page to manage the session, or false on error
      */
     public static function getAdminPath($id)
     {
@@ -7407,7 +7412,7 @@ 
      * If a course is provided, build the link to the course
      * @param   int $id Session ID
      * @param   int $courseId Course ID (optional) in case the link has to send straight to the course
-     * @return mixed    URL to the page to use the session, or false on error
+     * @return false|string    URL to the page to use the session, or false on error
      */
     public static function getPath($id, $courseId = 0)
     {
@@ -7505,7 +7510,7 @@ 
     /**
      * Return true if coach is allowed to access this session
      * @param int $sessionId
-     * @return bool
+     * @return integer
      */
     public static function isSessionDateOkForCoach($sessionId)
     {

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 int $course_id Id
 	 * @param string $title
-	 * @param Text $description
 	 */
 	public static function create_blog($title, $subtitle)
 	{
@@ -185,9 +183,7 @@ 
 	/**
 	 * Update title and subtitle of a blog in the given course
 	 * @author Toon Keppens
-	 * @param int $course_id Id
 	 * @param string $title
-	 * @param string $description
 	 */
 	public static function edit_blog($blog_id, $title, $subtitle)
 	{
@@ -711,7 +707,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)
 	{
@@ -1129,9 +1124,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)
 	{
@@ -2136,7 +2129,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)
 	{
@@ -2257,6 +2250,7 @@ 
 	 * @author Toon Keppens
 	 *
 	 * @param Integer $blog_id
+	 * @param integer $post_id
 	 */
 	public static function display_new_comment_form($blog_id, $post_id, $title)
 	{
@@ -2305,10 +2299,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
 	*/
@@ -2597,6 +2589,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
@@ -2638,6 +2631,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/exercice/exercise.class.php

Doc Comments +13 added lines, -8 removed lines

@@ -354,7 +354,7 @@ 
     }
 
     /**
-     * @return int
+     * @return string
      */
     public function selectPassPercentage()
     {
@@ -473,7 +473,7 @@ 
      * tells if questions are selected randomly, and if so returns the draws
      *
      * @author Olivier Brouckaert
-     * @return integer - 0 if not random, otherwise the draws
+     * @return boolean - 0 if not random, otherwise the draws
      */
     public function isRandom()
     {
@@ -2830,7 +2830,7 @@ 
      * @param int  int lp id
      * @param int  int lp item id
      * @param int  int lp item_view id
-     * @param float $weight
+     * @param integer $weight
      * @param array question list
      */
     public function save_stat_track_exercise_info(
@@ -5118,6 +5118,7 @@ 
     /**
      * Sends a notification when a user ends an examn
      *
+     * @param integer $exe_id
      */
     public function send_mail_notification_for_exam($question_list_answers, $origin, $exe_id)
     {
@@ -5198,6 +5199,7 @@ 
     /**
      * Sends a notification when a user ends an examn
      *
+     * @param integer $exe_id
      */
     function send_notification_for_open_questions($question_list_answers, $origin, $exe_id)
     {
@@ -5295,6 +5297,9 @@ 
         }
     }
 
+    /**
+     * @param integer $exe_id
+     */
     function send_notification_for_oral_questions($question_list_answers, $origin, $exe_id)
     {
         if (api_get_course_setting('email_alert_manager_on_new_quiz') != 1 ) {
@@ -5388,7 +5393,7 @@ 
 
     /**
      * @param array $user_data result of api_get_user_info()
-     * @param null $start_date
+     * @param string $start_date
      * @param null $duration
      * @param string $ip Optional. The user IP
      * @return string
@@ -5446,7 +5451,7 @@ 
      * @param int     Maximum number of attempts (0 if no limit)
      * @param int     Feedback type
      * @todo this was function was added due the import exercise via CSV
-     * @return    int New exercise ID
+     * @return    string New exercise ID
      */
     public function createExercise(
         $title,
@@ -6795,7 +6800,7 @@ 
      * @param bool $show_comment
      * @param null $exercise_feedback
      * @param bool $show_answers
-     * @param null $modelType
+     * @param integer $modelType
      * @param bool $categoryMinusOne
      * @return bool|null|string
      */
@@ -7956,8 +7961,8 @@ 
     /**
      * Returns an HTML ribbon to show on top of the exercise result, with
      * colouring depending on the success or failure of the student
-     * @param $score
-     * @param $weight
+     * @param integer $score
+     * @param integer $weight
      * @param bool $check_pass_percentage
      * @return string
      */

main/exercice/TestCategory.php

Doc Comments +2 added lines, -3 removed lines

@@ -367,7 +367,7 @@ 
 	 * Return the list of differents categories NAME for a test
 	 * @param int exercise id
 	 * @param bool
-	 * @return array of string
+	 * @return integer of string
 	 *
      * @author function rewrote by jmontoya
 	 */
@@ -983,7 +983,6 @@ 
     /**
      * Return the id of the test category with title = $in_title
      * @param $in_title
-     * @param int $in_c_id
      *
      * @return int is id of test category
      */
@@ -1011,7 +1010,7 @@ 
      * @param int $questionId
      * @param int $courseId
 	 *
-	 * @return int
+	 * @return string|false
      */
     public static function add_category_for_question_id($categoryId, $questionId, $courseId)
     {

main/gradebook/lib/GradebookUtils.php

Doc Comments +6 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())
     {
@@ -572,6 +572,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)
@@ -950,7 +953,7 @@ 
     }
 
     /**
-     * @param array $list_values
+     * @param string[] $list_values
      * @return string
      */
     public static function score_badges($list_values)
@@ -1010,7 +1013,7 @@ 
     }
 
     /**
-     * @param $result
+     * @param Doctrine\DBAL\Driver\Statement|null $result
      * @return array
      */
     public static function get_user_array_from_sql_result($result)