chamilo / chamilo-lms

main/inc/lib/phpseclib/Crypt/AES.php

Doc Comments +2 added lines

@@ -98,6 +98,7 @@ 
      * CRYPT_DES_MODE_ECB or CRYPT_DES_MODE_CBC.  If not explictly set, CRYPT_DES_MODE_CBC will be used.
      *
      * @param optional Integer $mode
+     * @param integer $mode
      * @return Crypt_TripleDES
      * @access public
      */
@@ -318,6 +319,7 @@ 
      *
      * @access public
      * @param String $plaintext
+     * @return string
      */
     function encrypt($plaintext)
     {

main/inc/lib/phpseclib/Crypt/Blowfish.php

Doc Comments +3 added lines

@@ -563,6 +563,7 @@ 
      * If not explictly set, CRYPT_TWOFISH_MODE_CBC will be used.
      *
      * @param optional Integer $mode
+     * @param integer $mode
      * @access public
      */
     function Crypt_Twofish($mode = CRYPT_TWOFISH_MODE_CBC)
@@ -1072,6 +1073,7 @@ 
      *
      * @see Crypt_Twofish::_unpad()
      * @access private
+     * @param string $text
      */
     function _pad($text)
     {
@@ -1099,6 +1101,7 @@ 
      *
      * @see Crypt_Twofish::_pad()
      * @access private
+     * @param string $text
      */
     function _unpad($text)
     {

main/newscorm/openoffice_text.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -38,7 +38,7 @@ 
     /**
      * Gets html pages and compose them into a learning path
      * @param	array	The files that will compose the generated learning path. Unused so far.
-     * @return	boolean	False if file does not exit. Nothing otherwise.
+     * @return	false|null	False if file does not exit. Nothing otherwise.
      */
     public function make_lp($files = array())
     {
@@ -92,6 +92,7 @@ 
      * Manages chapter splitting
      * @param	string	Chapter header
      * @param	string	Content
+     * @param string $content
      * @return	void
      */
     function dealPerChapter($header, $content)
@@ -164,6 +165,7 @@ 
      * Manages page splitting
      * @param	string	Page header
      * @param	string	Page body
+     * @param string $body
      * @return	void
      */
     function dealPerPage($header, $body)

main/user/subscribe_user.php

Doc Comments -1 removed lines

@@ -735,7 +735,6 @@
  * lock = the user can no longer use this account
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $active the current state of the account
- * @param int $user_id The user id
  * @param string $urlParams
  *
  * @return string Some HTML-code with the lock/unlock button

main/webservices/access_url.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 
 define('WS_ERROR_SECRET_KEY', 1);
 
+/**
+ * @param integer $code
+ */
 function return_error($code) {
     $fault = null;
     switch ($code) {

main/webservices/cm_webservice_course.php

Doc Comments +1 added lines

@@ -453,6 +453,7 @@
 	 * @param string Session id field name
 	 * @param string Session id value
 	 * @param int State (1 to subscribe, 0 to unsubscribe)
+	 * @param integer $state
 	 * @return mixed True on success, WSError otherwise
 	 */
 	protected function changeCourseSubscription($course_id_field_name, $course_id_value, $session_id_field_name, $session_id_value, $state) {

main/webservices/webservice_course.php

Doc Comments +1 added lines

@@ -453,6 +453,7 @@
 	 * @param string Session id field name
 	 * @param string Session id value
 	 * @param int State (1 to subscribe, 0 to unsubscribe)
+	 * @param integer $state
 	 * @return mixed True on success, WSError otherwise
 	 */
 	protected function changeCourseSubscription($course_id_field_name, $course_id_value, $session_id_field_name, $session_id_value, $state) {

main/inc/lib/document.lib.php

Doc Comments +21 added lines, -18 removed lines

@@ -277,7 +277,7 @@ 
     /**
      *  @param string
      *  @param string
-     * 	@return true if the user is allowed to see the document, false otherwise
+     * 	@return boolean if the user is allowed to see the document, false otherwise
      * 	@author Sergio A Kessler, first version
      * 	@author Roan Embrechts, bugfix
      *  @todo not only check if a file is visible, but also check if the user is allowed to see the file??
@@ -1527,7 +1527,7 @@ 
      * Return true if the documentpath have visibility=1 as
      * item_property (you should use the is_visible_by_id)
      *
-     * @param string $document_path the relative complete path of the document
+     * @param string $doc_path the relative complete path of the document
      * @param array  $course the _course array info of the document's course
      * @param int
      * @param string
@@ -1612,6 +1612,8 @@ 
      * @param   int
      * @param   int
      * @param bool
+     * @param integer $session_id
+     * @param integer $user_id
      * @return  bool
      */
     public static function is_visible_by_id(
@@ -2090,6 +2092,7 @@ 
      * @param	bool  	is file or string html
      * @param	string	type (one of the app tools) - optional (otherwise takes the current item's type)
      * @param	int		level of recursivity we're in
+     * @param string $source_html
      * @return	array	List of file paths. An additional field containing 'local' or 'remote' helps determine
      * if the file should be copied into the zip or just linked
      */
@@ -2913,6 +2916,7 @@ 
 
     /**
      * Obtains the text inside the file with the right parser
+     * @param string $doc_path
      */
     public static function get_text_content($doc_path, $doc_mime)
     {
@@ -3163,6 +3167,7 @@ 
      * Shows a play icon next to the document title in the document list
      * @param int
      * @param string
+     * @param integer|null $i
      * @return string	html content
      */
     static function generate_media_preview($i, $type = 'simple')
@@ -3557,7 +3562,7 @@ 
      * @param bool $add_move_button
      * @param string $target
      * @param string $overwrite_url
-     * @return null|string
+     * @return string
      */
     private static function parseFile(
         $course_info,
@@ -4058,7 +4063,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_web_odf_extension_list()
     {
@@ -4067,10 +4072,10 @@ 
 
     /**
      * Set of extension allowed to use Jodconverter
-     * @param $mode 'from'
+     * @param string $mode 'from'
      *              'to'
      *              'all'
-     * @param $format   'text'
+     * @param string $format   'text'
      *                  'spreadsheet'
      *                  'presentation'
      *                  'drawing'
@@ -4274,7 +4279,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_system_folders()
     {
@@ -4292,7 +4297,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getProtectedFolderFromStudent()
     {
@@ -4448,7 +4453,7 @@ 
      * Requires the ffmpeg lib. In ubuntu: sudo apt-get install ffmpeg
      * @param string $wavFile
      * @param bool $removeWavFileIfSuccess
-     * @return bool
+     * @return string|false
      */
     public static function convertWavToMp3($wavFile, $removeWavFileIfSuccess = false)
     {
@@ -5536,9 +5541,6 @@ 
     /**
      * Creates the row of edit icons for a file/folder
      *
-     * @param string $curdirpath current path (cfr open folder)
-     * @param string $type (file/folder)
-     * @param string $path dbase path of file/folder
      * @param int $visibility (1/0)
      * @param int $id dbase id of the document
      * @return string html img tags with hyperlinks
@@ -5867,7 +5869,7 @@ 
     /**
      * Gets the path translated with title of docs and folders
      * @param string $path the real path
-     * @return the path which should be displayed
+     * @return string path which should be displayed
      */
     public static function get_titles_of_path($path)
     {
@@ -5922,7 +5924,8 @@ 
 
     /**
      * Checks whether the user is in shared folder
-     * @return return bool Return true when user is into shared folder
+     * @param integer $current_session_id
+     * @return boolean bool Return true when user is into shared folder
      */
     public static function is_shared_folder($curdirpath, $current_session_id)
     {
@@ -5938,7 +5941,7 @@ 
 
     /**
      * Checks whether the user is into any user shared folder
-     * @return return bool Return true when user is in any user shared folder
+     * @return boolean bool Return true when user is in any user shared folder
      */
     public static function is_any_user_shared_folder($path, $current_session_id)
     {
@@ -6152,7 +6155,7 @@ 
      * @param int $id
      * @param array $courseInfo
      * @param int $sessionId
-     * @return bool
+     * @return boolean|null
      */
     public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
     {
@@ -6171,7 +6174,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function downloadAllDeletedDocument($courseInfo, $sessionId)
     {
@@ -6210,7 +6213,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public function deleteDocumentsFromSession($courseInfo, $sessionId)
     {

main/dropbox/dropbox_functions.inc.php

Doc Comments +8 added lines, -7 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
@@ -786,6 +786,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.
 */
@@ -1147,7 +1148,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
@@ -1164,7 +1165,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
@@ -1225,7 +1226,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