chamilo / chamilo-lms

main/cron/import_csv.php

Doc Comments +2 added lines, -2 removed lines

@@ -48,7 +48,7 @@ 
     public $conditions;
 
     /**
-     * @param Logger $logger
+     * @param Monolog\Logger $logger
      * @param array
      */
     public function __construct($logger, $conditions)
@@ -66,7 +66,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function getDumpValues()
     {

main/dropbox/dropbox_class.inc.php

Doc Comments +2 added lines, -1 removed lines

@@ -266,7 +266,7 @@ 
 	 * @param string $author
 	 * @param string $filename
 	 * @param int $filesize
-	 * @param array $recipient_ids
+	 * @param unknown_type|null $recipient_ids
 	 */
 	public function _createNewSentWork($uploader_id, $title, $description, $author, $filename, $filesize, $recipient_ids)
     {
@@ -584,6 +584,7 @@ 
 
 	/**
 	 * Deletes all the received categories and work of this person
+	 * @param integer $id
 	 */
 	function deleteReceivedWorkFolder($id)
     {

main/dropbox/dropbox_functions.inc.php

Doc Comments +9 added lines, -8 removed lines

@@ -22,7 +22,7 @@ 
 
 /**
 * This function is a wrapper function for the multiple actions feature.
-* @return   Mixed   If there is a problem, return a string message, otherwise nothing
+* @return   string|null   If there is a problem, return a string message, otherwise nothing
 * @author   Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version  march 2006
 */
@@ -209,9 +209,9 @@ 
 *
 * @param $id the id of the file we are moving
 * @param $target the id of the folder we are moving to
-* @param $part are we moving a received file or a sent file?
+* @param string $part are we moving a received file or a sent file?
 *
-* @return language string
+* @return string string
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version march 2006
@@ -290,7 +290,7 @@ 
 * @param $id the unique id of the file
 * @param $part are we dealing with a sent or with a received file?
 *
-* @return html code
+* @return string code
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version march 2006
@@ -737,6 +737,7 @@ 
 }
 
 /**
+* @param string $user_id
 * @return boolean indicating if user with user_id=$user_id is a course member
 * @todo check if this function is still necessary. There might be a library function for this.
 */
@@ -860,7 +861,7 @@ 
 }
 
 /**
- * @return array|null|string
+ * @return string|null
  */
 function store_add_dropbox()
 {
@@ -1077,7 +1078,7 @@ 
 /**
 * This function returns the html code to display the feedback messages on a given dropbox file
 * @param $feedback_array an array that contains all the feedback messages about the given document.
-* @return html code
+* @return string code
 * @todo add the form for adding new comment (if the other party has not deleted it yet).
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1094,7 +1095,7 @@ 
 
 /**
 * this function returns the code for the form for adding a new feedback message to a dropbox file.
-* @return html code
+* @return string code
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version march 2006
@@ -1155,7 +1156,7 @@ 
 }
 
 /**
-* @return a language string (depending on the success or failure.
+* @return string language string (depending on the success or failure.
 *
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @version march 2006

main/exercice/answer.class.php

Doc Comments +10 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')
@@ -300,6 +301,7 @@ 
 	 * returns the question ID of the destination question
 	 *
 	 * @author Julio Montoya
+	 * @param integer $id
 	 * @return integer - the question ID
 	 */
 	public function selectDestination($id)
@@ -321,6 +323,7 @@ 
 
 	/**
 	 * return array answer by id else return a bool
+	 * @param integer $auto_id
 	 */
 	public function selectAnswerByAutoId($auto_id)
 	{
@@ -435,6 +438,7 @@ 
 	 *
 	 * @author Olivier Brouckaert
 	 * @param - integer $id - answer ID
+	 * @param integer $id
 	 * @return integer - 0 if bad answer, not 0 if good answer
 	 */
     public function isCorrect($id)
@@ -447,6 +451,7 @@ 
 	 *
 	 * @author Olivier Brouckaert
 	 * @param - integer $id - answer ID
+	 * @param integer $id
 	 * @return string - answer comment
 	 */
     public function selectComment($id)
@@ -459,6 +464,7 @@ 
 	 *
 	 * @author Olivier Brouckaert
 	 * @param - integer $id - answer ID
+	 * @param integer $id
 	 * @return integer - answer weighting
 	 */
     public function selectWeighting($id)
@@ -483,6 +489,7 @@ 
 	 *
 	 * @author	Olivier Brouckaert
 	 * @param	integer	Answer ID
+	 * @param integer $id
 	 * @return	integer	Answer position
 	 */
     public function selectHotspotCoordinates($id)
@@ -495,6 +502,7 @@ 
 	 *
 	 * @author	Toon Keppens
 	 * @param	integer		Answer ID
+	 * @param integer $id
 	 * @return	integer		Answer position
 	 */
     public function selectHotspotType($id)
@@ -550,6 +558,7 @@ 
      * @param string $destination
      * @param string $hotspot_coordinates
      * @param string $hotspot_type
+     * @param integer $autoId
      */
     public function updateAnswers(
         $autoId,
@@ -720,6 +729,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 +10 added lines, -5 removed lines

@@ -283,7 +283,7 @@ 
     }
 
     /**
-     * @return int
+     * @return string
      */
     public function selectPassPercentage()
     {
@@ -378,7 +378,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()
     {
@@ -1856,7 +1856,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(
@@ -4121,6 +4121,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)
     {
@@ -4201,6 +4202,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)
     {
@@ -4298,6 +4300,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 ) {
@@ -4391,7 +4396,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
@@ -4449,7 +4454,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,

main/exercice/export/aiken/aiken_classes.php

Doc Comments +4 added lines

@@ -10,6 +10,10 @@
 if ( count( get_included_files() ) == 1 ) die( '---' );
 
 if (!function_exists('mime_content_type')) {
+
+	/**
+	 * @param string $filename
+	 */
 	function mime_content_type($filename) {
 		return DocumentManager::file_get_mime_type((string)$filename);
 	}

main/exercice/export/aiken/aiken_import.inc.php

Doc Comments +6 added lines, -1 removed lines

@@ -55,6 +55,8 @@ 
  * Gets the uploaded file (from $_FILES) and unzip it to the given directory
  * @param string The directory where to do the work
  * @param string The path of the temporary directory where the exercise was uploaded and unzipped
+ * @param string $baseWorkDir
+ * @param string $uploadPath
  * @return bool True on success, false on failure
  */
 function get_and_unzip_uploaded_exercise($baseWorkDir, $uploadPath) {
@@ -229,7 +231,10 @@ 
  * @param string Path to the directory with the file to be parsed (without final /)
  * @param string Name of the last directory part for the file (without /)
  * @param string Name of the file to be parsed (including extension)
- * @return mixed True on success, error message on error
+ * @param string $exercisePath
+ * @param string $file
+ * @param string $questionFile
+ * @return string|boolean True on success, error message on error
  * @assert ('','','') === false
  */
 function aiken_parse_file(&$exercise_info, $exercisePath, $file, $questionFile) {

main/exercice/export/exercise_import.inc.php

Doc Comments +5 added lines, -3 removed lines

@@ -30,6 +30,8 @@ 
  * Unzip the exercise in the temp folder
  * @param string The path of the temporary directory where the exercise was uploaded and unzipped
  * @param string
+ * @param string $baseWorkDir
+ * @param string $uploadPath
  * @return bool
  */
 function get_and_unzip_uploaded_exercise($baseWorkDir, $uploadPath)
@@ -217,9 +219,9 @@ 
 
 /**
  * Parses a given XML file and fills global arrays with the elements
- * @param $exercisePath
- * @param $file
- * @param $questionFile
+ * @param string $exercisePath
+ * @param string $file
+ * @param string $questionFile
  * @return bool
  */
 function parse_file($exercisePath, $file, $questionFile)

main/exercice/export/qti2/qti2_export.php

Doc Comments +9 added lines, -6 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * Constructor.
      *
-     * @param $question Ims2Question object we want to export.
+     * @param Ims2Question $question Ims2Question object we want to export.
      */
      function ImsAssessmentItem($question)
      {
@@ -101,7 +101,7 @@ 
       * This is a default behaviour, some classes may want to override this.
       *
       * @param $standalone: Boolean stating if it should be exported as a stand-alone question
-      * @return A string, the XML flow for an Item.
+      * @return string string, the XML flow for an Item.
       */
      function export($standalone = false)
      {
@@ -154,7 +154,7 @@ 
 
     /**
      * Constructor.
-     * @param $exe The Exercise instance to export
+     * @param Exercise $exe The Exercise instance to export
      * @author Amand Tihon <amand@alrj.org>
      */
     function ImsSection($exe)
@@ -239,7 +239,7 @@ 
      * Export the exercise in IMS/QTI.
      *
      * @param bool $standalone Wether it should include XML tag and DTD line.
-     * @return a string containing the XML flow
+     * @return string string containing the XML flow
      * @author Amand Tihon <amand@alrj.org>
      */
     function export($standalone)
@@ -383,7 +383,7 @@ 
       * This is a default behaviour, some classes may want to override this.
       *
       * @param $standalone: Boolean stating if it should be exported as a stand-alone question
-      * @return A string, the XML flow for an Item.
+      * @return string string, the XML flow for an Item.
       * @author Amand Tihon <amand@alrj.org>
       */
      function export($standalone = False)
@@ -417,7 +417,7 @@ 
  *
  * @param int $exerciseId The exercise to export
  * @param boolean $standalone Wether it should include XML tag and DTD line.
- * @return The XML as a string, or an empty string if there's no exercise with given ID.
+ * @return string XML as a string, or an empty string if there's no exercise with given ID.
  */
 function export_exercise_to_qti($exerciseId, $standalone = true)
 {
@@ -474,6 +474,9 @@ 
     return htmlspecialchars($text);
 }
 
+/**
+ * @param string $text
+ */
 function cleanAttribute($text)
 {
     return $text;