chamilo / chamilo-lms

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

Doc Comments +37 added lines

@@ -24,6 +24,10 @@ 
 	 * @param int       Question ID
      * @param int $resultsDisabled
      * @param string $originalStudentAnswer
+     * @param integer $feedbackType
+     * @param string $answer
+     * @param integer $id
+     * @param integer $questionId
 	 * @return void
 	 */
 	public static function display_fill_in_blanks_answer($feedbackType, $answer, $id, $questionId, $resultsDisabled, $originalStudentAnswer = '')
@@ -62,6 +66,10 @@ 
      * @param string    Answer text
      * @param int       Exercise ID
      * @param int       Question ID
+     * @param integer $feedback_type
+     * @param string $answer
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     static function display_calculated_answer($feedback_type, $answer, $id, $questionId)
@@ -95,6 +103,9 @@ 
 	 * @param string    Answer text
 	 * @param int       Exercise ID
 	 * @param int       Question ID
+	 * @param integer $feedback_type
+	 * @param integer $exe_id
+	 * @param integer $questionId
 	 * @return void
 	 */
 	static function display_free_answer($feedback_type, $answer, $exe_id, $questionId, $questionScore = null)
@@ -117,6 +128,12 @@ 
         }
 	}
 
+	/**
+	 * @param integer $feedback_type
+	 * @param integer $id
+	 * @param integer $questionId
+	 * @param Nanogong $nano
+	 */
 	static function display_oral_expression_answer($feedback_type, $answer, $id, $questionId, $nano = null)
     {
         if (isset($nano)) {
@@ -234,6 +251,12 @@ 
 	 * @param integer Exercise ID
 	 * @param integer Question ID
 	 * @param boolean Whether to show the answer comment or not
+	 * @param integer $answerType
+	 * @param string $answer
+	 * @param string $answerComment
+	 * @param integer $answerCorrect
+	 * @param integer $id
+	 * @param integer $questionId
 	 * @return void
 	 */
 	static function display_unique_or_multiple_answer(
@@ -318,6 +341,13 @@ 
      * @param integer Exercise ID
      * @param integer Question ID
      * @param boolean Whether to show the answer comment or not
+     * @param integer $feedback_type
+     * @param integer $answerType
+     * @param string $answer
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     static function display_multiple_answer_true_false(
@@ -408,6 +438,13 @@ 
      * @param integer Exercise ID
      * @param integer Question ID
      * @param boolean Whether to show the answer comment or not
+     * @param integer $feedback_type
+     * @param integer $answerType
+     * @param string $answer
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     static function display_multiple_answer_combination_true_false(

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/newscorm/learnpath.class.php

Doc Comments +29 added lines, -24 removed lines

@@ -84,7 +84,7 @@ 
      * @param	string	$course Course code
      * @param	integer	$lp_id
      * @param	integer	$user_id
-     * @return mixed True on success, false on error
+     * @return boolean True on success, false on error
      */
     public function __construct($course, $lp_id, $user_id)
     {
@@ -484,8 +484,9 @@ 
      * @param int $prerequisites
      * @param int $max_time_allowed
      * @param int $userId
+     * @param string $id
      *
-     * @return int
+     * @return false|string
      */
     public function add_item(
         $parent,
@@ -1036,7 +1037,7 @@ 
      * @param	array $courseInfo
      * @param	integer	Learnpath ID
      * @param	string	Whether to delete data or keep it (default: 'keep', others: 'remove')
-     * @return	boolean	True on success, false on failure (might change that to return number of elements deleted)
+     * @return	false|null	True on success, false on failure (might change that to return number of elements deleted)
      */
     public function delete($courseInfo = null, $id = null, $delete = 'keep')
     {
@@ -1170,7 +1171,7 @@ 
      * @param	integer	$id Elem ID (0 if first)
      * @param	integer	$remove Whether to remove the resource/data from the
      * system or leave it (default: 'keep', others 'remove')
-     * @return	integer	Number of elements moved
+     * @return	false|null	Number of elements moved
      * @todo implement resource removal
      */
     public function delete_item($id, $remove = 'keep')
@@ -1252,7 +1253,7 @@ 
      * @param   array   $audio The array resulting of the $_FILES[mp3] element
      * @param   int     $max_time_allowed
      * @param   string  $url
-     * @return  boolean True on success, false on error
+     * @return  false|null True on success, false on error
      */
     public function edit_item(
         $id,
@@ -1775,7 +1776,7 @@ 
 
     /**
      * Gets the first element URL.
-     * @return	string	URL to load into the viewer
+     * @return	false|null	URL to load into the viewer
      */
     public function first()
     {
@@ -2291,6 +2292,7 @@ 
      * @param int $student_id
      * @param string Course code (optional)
      * @param int $sessionId
+     * @param string $courseCode
      * @return	bool
      */
     public static function is_lp_visible_for_student(
@@ -2590,7 +2592,7 @@ 
 
     /**
      * Gets the learnpath session id
-     * @return	string	Learnpath theme
+     * @return	integer	Learnpath theme
      */
     public function get_lp_session_id()
     {
@@ -2623,7 +2625,7 @@ 
     /**
      * @param string $size
      * @param string $path_type
-     * @return bool|string
+     * @return string|false
      */
     public function get_preview_image_path($size = null, $path_type = 'web')
     {
@@ -2769,6 +2771,8 @@ 
      * Returns the XML DOM document's node
      * @param	resource	Reference to a list of objects to search for the given ITEM_*
      * @param	string		The identifier to look for
+     * @param DOMNodeList $children
+     * @param string $id
      * @return	mixed		The reference to the element found with that identifier. False if not found
      */
     public function get_scorm_xml_node(& $children, $id)
@@ -3016,7 +3020,7 @@ 
     /**
      * Generate and return the table of contents for this learnpath. The (flat) table returned can be
      * used by get_html_toc() to be ready to display
-     * @return	array	TOC as a table with 4 elements per row: title, link, status and level
+     * @return	boolean	TOC as a table with 4 elements per row: title, link, status and level
      */
     public function get_toc()
     {
@@ -3152,7 +3156,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getChapterTypes()
     {
@@ -4054,7 +4058,7 @@ 
      * Open a resource = initialise all local variables relative to this resource. Depending on the child
      * class, this might be redefined to allow several behaviours depending on the document type.
      * @param integer Resource ID
-     * @return boolean True on success, false otherwise
+     * @return boolean|null True on success, false otherwise
      */
     public function open($id)
     {
@@ -4183,7 +4187,7 @@ 
      * Can be used as abstract
      * @param	integer	$lp_id Learnpath id
      * @param	string	$set_visibility New visibility (v/i - visible/invisible)
-     * @return bool
+     * @return false|null
      */
     public static function toggle_publish($lp_id, $set_visibility = 'v')
     {
@@ -4268,7 +4272,7 @@ 
      * Make sure the results are saved with anoter method. This method should probably be
      * redefined in children classes.
      * To use a similar method  statically, use the create_new_attempt() method
-     * @return string URL to load in the viewer
+     * @return boolean URL to load in the viewer
      */
     public function restart()
     {
@@ -4346,6 +4350,7 @@ 
      * Saves the given item
      * @param	integer	$item_id. Optional (will take from $_REQUEST if null)
      * @param	boolean	$from_outside Save from url params (true) or from current attributes (false). Optional. Defaults to true
+     * @param integer $item_id
      * @return	boolean
      */
     public function save_item($item_id = null, $from_outside = true)
@@ -4843,7 +4848,7 @@ 
 
     /**
      * Sets use_max_score
-     * @param   string  $use_max_score Optional string giving the new location of this learnpath
+     * @param   integer  $use_max_score Optional string giving the new location of this learnpath
      * @return  boolean True on success / False on error
      */
     public function set_use_max_score($use_max_score = 1)
@@ -5244,6 +5249,7 @@ 
      * Register the attempt mode into db thanks to flags prevent_reinit and seriousgame_mode flags
      *
      * @param string 'seriousgame', 'single' or 'multiple'
+     * @param string $mode
      * @return boolean
      * @author ndiechburg <noel@cblue.be>
      **/
@@ -5286,7 +5292,7 @@ 
     /**
      * Switch between multiple attempt, single attempt or serious_game mode (only for scorm)
      *
-     * @return boolean
+     * @return boolean|null
      * @author ndiechburg <noel@cblue.be>
      **/
     public function switch_attempt_mode()
@@ -5477,7 +5483,6 @@ 
     /**
      * Function that creates a html list of learning path items so that we can add audio files to them
      * @author Kevin Van Den Haute
-     * @param int $lp_id
      * @return string
      */
     public function overview()
@@ -5838,7 +5843,7 @@ 
     /**
      * This function builds the action menu
      * @param bool $returnContent
-     * @return void
+     * @return string|null
      */
     public function build_action_menu($returnContent = false)
     {
@@ -6335,7 +6340,7 @@ 
     /**
      * Function that displays a list with al the resources that
      * could be added to the learning path
-     * @return string
+     * @return boolean
      */
     public function display_resources()
     {
@@ -8779,7 +8784,7 @@ 
 
     /**
      * Creates a list with all the student publications in it
-     * @return unknown
+     * @return string
      */
     public function get_student_publications()
     {
@@ -9723,7 +9728,7 @@ 
 
     /**
      * @param int $lp_id
-     * @return bool
+     * @return false|null
      */
     public function scorm_export_to_pdf($lp_id)
     {
@@ -10240,6 +10245,7 @@ 
     }
 
     /**
+     * @param string $courseCode
      * @return \learnpath
      */
     public static function getLpFromSession($courseCode, $lp_id, $user_id)
@@ -10259,7 +10265,7 @@ 
 
     /**
      * @param int $itemId
-     * @return learnpathItem|false
+     * @return string
      */
     public function getItem($itemId)
     {
@@ -10309,7 +10315,6 @@ 
     /**
      * Set whether this is a learning path with the possibility to subscribe
      * users or not
-     * @param int $subscribeUsers (0 = false, 1 = true)
      */
     public function setSubscribeUsers($value)
     {
@@ -10434,7 +10439,7 @@ 
 
     /**
      * Get the item of exercise type (evaluation type)
-     * @return array The final evaluation. Otherwise return false
+     * @return integer The final evaluation. Otherwise return false
      */
     public function getFinalEvaluationItem()
     {
@@ -10658,7 +10663,7 @@ 
     /**
      * Create a forum for this learning path
      * @param type $forumCategoryId
-     * @return int The forum ID if was created. Otherwise return false
+     * @return false|string The forum ID if was created. Otherwise return false
      */
     public function createForum($forumCategoryId)
     {

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/answer.class.php

Doc Comments +8 added lines

@@ -186,6 +186,7 @@ 
      * Reads answer information from the data base ordered by parameter
      * @param	string	Field we want to order by
      * @param	string	DESC or ASC
+     * @param string $field
      * @author 	Frederic Vauthier
      */
     public function readOrderedBy($field, $order='ASC')
@@ -304,6 +305,7 @@ 
 	 * returns the question ID of the destination question
 	 *
 	 * @author Julio Montoya
+	 * @param integer $id
 	 * @return integer - the question ID
 	 */
 	public function selectDestination($id)
@@ -325,6 +327,7 @@ 
 
 	/**
 	 * return array answer by id else return a bool
+	 * @param integer $auto_id
 	 */
 	public function selectAnswerByAutoId($auto_id)
 	{
@@ -463,6 +466,7 @@ 
 	 *
 	 * @author Olivier Brouckaert
 	 * @param - integer $id - answer ID
+	 * @param integer $id
 	 * @return integer - answer weighting
 	 */
     public function selectWeighting($id)
@@ -487,6 +491,7 @@ 
 	 *
 	 * @author	Olivier Brouckaert
 	 * @param	integer	Answer ID
+	 * @param integer $id
 	 * @return	integer	Answer position
 	 */
     public function selectHotspotCoordinates($id)
@@ -499,6 +504,7 @@ 
 	 *
 	 * @author	Toon Keppens
 	 * @param	integer		Answer ID
+	 * @param integer $id
 	 * @return	integer		Answer position
 	 */
     public function selectHotspotType($id)
@@ -554,6 +560,7 @@ 
      * @param string $destination
      * @param string $hotspot_coordinates
      * @param string $hotspot_type
+     * @param integer $autoId
      */
     public function updateAnswers(
         $autoId,
@@ -724,6 +731,7 @@ 
 	 * @author Olivier Brouckaert
 	 * @param  int question id
      * @param  array destination course info (result of the function api_get_course_info() )
+     * @param string $newQuestionId
 	 */
     public function duplicate($newQuestionId, $course_info = null)
     {

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)
     {