chamilo / chamilo-lms

main/coursecopy/classes/CourseArchiver.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
 
     /**
      * @param array $file
-     * @return bool|string
+     * @return string|false
      */
     public static function import_uploaded_file($file)
     {

main/coursecopy/classes/CourseBuilder.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
     }
 
     /**
-     * @param array $array
+     * @param string[] $array
      */
     public function set_tools_to_build($array)
     {
@@ -123,7 +123,7 @@ 
      * @param string   $courseCode
      * @param bool     true if you want to get the elements that exists in the course and
      *                 in the session, (session_id = 0 or session_id = X)
-     * @return object The course object structure
+     * @return Course The course object structure
      */
     public function build(
         $session_id = 0,

main/coursecopy/classes/CourseRestorer.class.php

Doc Comments +8 added lines, -1 removed lines

@@ -84,6 +84,7 @@ 
 
 	/**
 	 * Create a new CourseRestorer
+	 * @param Course $course
 	 */
     public function __construct($course)
     {
@@ -132,7 +133,7 @@ 
 	 * @param int	    $session_id
 	 * @param bool	    $update_course_settings Course settings are going to be restore?
      * @param bool      $respect_base_content
-     * @return bool
+     * @return false|null
 	 */
     public function restore(
         $destination_course_code = '',
@@ -1084,6 +1085,7 @@ 
 
 	/**
 	 * Restore a forum-topic
+	 * @param false|string $forum_id
 	 */
     public function restore_topic($thread_id, $forum_id, $sessionId = 0)
     {
@@ -1140,6 +1142,7 @@ 
 	/**
 	 * Restore a forum-post
 	 * @TODO Restore tree-structure of posts. For example: attachments to posts.
+	 * @param false|string $topic_id
 	 */
     public function restore_post($id, $topic_id, $forum_id, $sessionId = 0)
     {
@@ -2231,6 +2234,7 @@ 
 
 	/**
 	 * Check availability of a survey code
+	 * @param string $survey_code
 	 */
     public function is_survey_code_available($survey_code)
     {
@@ -2245,6 +2249,7 @@ 
 
 	/**
 	 * Restore survey-questions
+	 * @param string $survey_id
 	 */
     public function restore_survey_question($id, $survey_id)
     {
@@ -2701,6 +2706,8 @@ 
     * @param string The path origin
     * @param string The path destination
     * @param boolean Option Overwrite
+    * @param string $source
+    * @param string $dest
     * @return void()
     * @deprecated
     */

main/coursecopy/classes/CourseSelectForm.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -13,7 +13,7 @@ 
 {
 	/**
 	 * Display the form
-	 * @param array $hidden_fiels Hidden fields to add to the form.
+	 * @param array $hidden_fields Hidden fields to add to the form.
 	 * @param boolean the document array will be serialize. This is used in the course_copy.php file
 	 */
 	static function display_form($course, $hidden_fields = null, $avoid_serialize = false)
@@ -570,7 +570,7 @@ 
 
 	/**
 	 * Display the form session export
-	 * @param array $hidden_fiels Hidden fields to add to the form.
+	 * @param array $hidden_fields Hidden fields to add to the form.
 	 * @param boolean the document array will be serialize. This is used in the course_copy.php file
 	 */
 	 public static function display_form_session_export($list_course, $hidden_fields = null, $avoid_serialize = false)

main/coursecopy/classes/DummyCourseCreator.class.php

Doc Comments +1 added lines

@@ -280,6 +280,7 @@
 	}
 	/**
 	 * Get dummy titles, descriptions and texts
+	 * @param string $type
 	 */
 	function get_dummy_content($type)
 	{

main/coursecopy/classes/Event.class.php

Doc Comments -3 removed lines

@@ -50,9 +50,6 @@
      * @param int $id
      * @param string $title
      * @param string $content
-     * @param string $date
-     * @param string $hour
-     * @param int $duration
      */
     public function __construct(
         $id,

main/coursecopy/classes/QuizQuestion.class.php

Doc Comments +3 added lines

@@ -115,6 +115,9 @@
         $this->answers[] = $answer;
     }
 
+    /**
+     * @param QuizQuestionOption $option_obj
+     */
     public function add_option($option_obj)
     {
         $this->question_options[$option_obj->obj->id] = $option_obj;

main/coursecopy/classes/Resource.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
 
     /**
      * Resturns the type of this resource
-     * @return constant The type.
+     * @return integer The type.
      */
     public function get_type()
     {

main/coursecopy/copy_course_session_selected.php

Doc Comments +3 added lines

@@ -65,6 +65,9 @@
 
 /* FUNCTIONS */
 
+/**
+ * @param string $name
+ */
 function make_select_session_list($name, $sessions, $attr = array())
 {