chamilo / chamilo-lms

main/plagiarism/compilatio/compilatio.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -226,7 +226,7 @@ 
 	 * @param $pour
 	 * @param $imagesPath
 	 * @param $text  Array includes the extract from the text
-	 * @return unknown_type
+	 * @return string|null
 	 */
 	function getProgressionAnalyseDocv31($status, $pour = 0, $imagesPath = '', $text = '')
 	{
@@ -281,11 +281,11 @@ 
 	 * Method for display the PomprseuilmankBar (% de plagiat)
 	 *
 	 * @param $percentagePumping
-	 * @param $weakThreshold
-	 * @param $highThreshold
+	 * @param integer $weakThreshold
+	 * @param integer $highThreshold
 	 * @param $imagesPath
 	 * @param $text : array  includes the extract from the text
-	 * @return unknown_type
+	 * @return string
 	 */
 	function getPomprankBarv31($pourcentagePompage, $weakThreshold, $highThreshold, $chemin_images='',$texte='') {
 

main/plagiarism/compilatio/upload.php

Doc Comments +6 added lines

@@ -278,6 +278,9 @@ 
 }
 
 
+/**
+ * @param string $txt
+ */
 function getFilename($txt) {
     $res = $txt;
     preg_match("|.*/([^/]+)|", $txt, $urlList);
@@ -287,6 +290,9 @@ 
     return $res;
 }
 
+/**
+ * @param string $txt
+ */
 function getWorkFolder($txt) {
     $res = "";
     preg_match("|(.*/)[^/]+|", $txt, $urlList);

main/work/work.lib.php

Doc Comments +21 added lines, -17 removed lines

@@ -158,7 +158,7 @@ 
  * Create a group of select from a date
  * @param FormValidator $form
  * @param string $prefix
- * @return array
+ * @return HTML_QuickForm_element[]
  */
 function create_group_date_select($form, $prefix = '')
 {
@@ -752,7 +752,7 @@ 
  * @author Bert Vanderkimpen
  * @author Yannick Warnier <ywarnier@beeznest.org> Adaptation for work tool
  * @param   string $base_work_dir Base work dir (.../work)
- * @param   string $desiredDirName complete path of the desired name
+ * @param   string $desired_dir_name complete path of the desired name
  *
  * @return  string actual directory name if it succeeds, boolean false otherwise
  */
@@ -774,7 +774,7 @@ 
 /**
  * Delete a work-tool directory
  * @param   int  $id work directory id to delete
- * @return  integer -1 on error
+ * @return  boolean|null -1 on error
  */
 function deleteDirWork($id)
 {
@@ -917,7 +917,7 @@ 
  * Update the url of a dir in the student_publication table
  * @param  array $work_data work original data
  * @param  string $newPath Example: "folder1"
- * @return bool
+ * @return boolean|null
  */
 function updateDirName($work_data, $newPath)
 {
@@ -974,6 +974,7 @@ 
 /**
  * Transform an all directory structure (only directories) in an array
  * @param   string path of the directory
+ * @param string $directory
  * @return  array the directory structure into an array
  * @author  Julio Montoya Dokeos
  * @version April 2008
@@ -1043,7 +1044,7 @@ 
  * @param   string the path of the directory
  * @param   boolean true if we want the total quantity of files
  * include in others child directories, false only  files in the directory
- * @return  array the first element is an integer with the number of files
+ * @return  integer[] the first element is an integer with the number of files
  * in the folder, the second element is the number of directories
  * @author  Julio Montoya
  * @version April 2008
@@ -2387,7 +2388,7 @@ 
 }
 
 /**
- * @param $name
+ * @param string $name
  * @param $values
  * @param string $checked
  * @return string
@@ -2913,7 +2914,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -3031,7 +3032,7 @@ 
 /**
  * Get total score from a work list
  * @param $workList
- * @return int|null
+ * @return integer
  */
 function getTotalWorkScore($workList)
 {
@@ -3047,7 +3048,7 @@ 
  * Get comment count from a work list (docs sent by students)
  * @param array $workList
  * @param array $courseInfo
- * @return int|null
+ * @return integer
  */
 function getTotalWorkComment($workList, $courseInfo = array())
 {
@@ -3190,6 +3191,7 @@ 
  * @param int $parentId
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -3826,12 +3828,11 @@ 
 
 /**
  * Creates a new task (directory) in the assignment tool
- * @param array $params
  * @param int $user_id
  * @param array $courseInfo
  * @param int $group_id
  * @param int $session_id
- * @return bool|int
+ * @return string|false
  * @note $params can have the following elements, but should at least have the 2 first ones: (
  *       'new_dir' => 'some-name',
  *       'description' => 'some-desc',
@@ -4327,7 +4328,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4699,7 +4700,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4817,7 +4818,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4865,7 +4866,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -5003,7 +5004,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -5117,7 +5118,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {
@@ -5192,6 +5193,9 @@ 
 /*
  * function for delete a document of the compilatio table if plagiarismTool is Compilatio
  */
+/**
+ * @param integer $itemId
+ */
 function plagiarismDeleteDoc($courseId, $itemId)
 {
     if (plagiarismActive()) {