chamilo / chamilo-lms

main/newscorm/openoffice_document.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -171,7 +171,8 @@
     /**
      * Get images files from remote host (with webservices)
      * @param   array current ppt file
-     * @return  array images files
+     * @param string $file
+     * @return  string images files
      */
     private function _get_remote_ppt2lp_files($file)
     {

main/newscorm/openoffice_text_document.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/newscorm/resourcelinker.inc.php

Doc Comments +4 added lines

@@ -320,6 +320,10 @@
  * @param icon        - if ="icon" then the small icon will appear
  *                      if ="wrap" then wrapped settings are used (and no icon is displayed)
  *                      if ="nolink" then only the name is returned with no href and no icon (note:only in this case, the result is not displayed, but returned)
+ * @param string $completed
+ * @param string $id_in_path
+ * @param string $builder
+ * @param string $icon
  * @todo this function is too long, rewrite
  */
 function display_addedresource_link_in_learnpath($type, $id, $completed, $id_in_path, $builder, $icon, $level = 0) {

main/newscorm/scorm.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -271,7 +271,7 @@ 
      * @param int $userMaxScore
      * @param int $sessionId
      *
-     * @return bool	Returns -1 on error
+     * @return boolean|null	Returns -1 on error
      */
     public function import_manifest($courseCode, $userMaxScore = 1, $sessionId = 0, $userId = 0)
     {
@@ -925,7 +925,7 @@ 
      * @param	string	course Code
      * @param string	LP ID (in database)
      * @param string	Manifest file path (optional if lp_id defined)
-     * @return	integer	New LP ID or false on failure
+     * @return	boolean	New LP ID or false on failure
      * TODO @TODO Implement imsmanifest_path parameter
      */
     public function reimport_manifest($courseCode, $lp_id = null, $imsmanifest_path = '')

main/permissions/permissions_functions.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -118,7 +118,7 @@ 
 
 /**
 * This function retrieves the existing permissions of a user, group or role.
-* @param $content are we retrieving the rights of a user, a group or a role (the database depends on it)
+* @param string $content are we retrieving the rights of a user, a group or a role (the database depends on it)
 * @param $id the id of the user, group or role
 * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
 * @version 1.0
@@ -526,7 +526,7 @@ 
 
 /**
 * This function gets all the roles that are defined
-* @param $content are we finding the roles for a user or a group (the database depends on it)
+* @param string $content are we finding the roles for a user or a group (the database depends on it)
 * @param $id the id of the user or group
 * @param string	Deprecated parameter allowing use of 'platform' scope - the corresponding tables don't exist anymore so the scope is always set to 'course'
 * @return array that contains the name of the roles the user has

main/resourcelinker/resourcelinker.inc.php

Doc Comments +4 added lines

@@ -338,6 +338,10 @@
 * @param icon        - if ="icon" then the small icon will appear
 *                      if ="wrap" then wrapped settings are used (and no icon is displayed)
 *                      if ="nolink" then only the name is returned with no href and no icon (note:only in this case, the result is not displayed, but returned)
+* @param string $completed
+* @param string $id_in_path
+* @param string $builder
+* @param string $icon
 * @todo this function is too long, rewrite
 */
 function display_addedresource_link_in_learnpath($type, $id, $completed, $id_in_path, $builder, $icon, $level = 0)

main/user/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/additional_webservices.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 }
 
 /**
- * @param $directoryPath
+ * @param string $directoryPath
  * @return bool
  */
 function deleteDirectory($directoryPath)

main/webservices/cm_webservice.php

Doc Comments +5 added lines, -1 removed lines

@@ -32,6 +32,8 @@ 
 	 *
 	 * @param int Error code
 	 * @param string Error message
+	 * @param integer $code
+	 * @param string $message
 	 */
 	public function __construct($code, $message) {
 		$this->code = $code;
@@ -42,6 +44,7 @@ 
 	 * Sets the error handler
 	 *
 	 * @param WSErrorHandler Error handler
+	 * @param WSCMSoapErrorHandler $handler
 	 */
 	public static function setErrorHandler($handler) {
 		if($handler instanceof WSErrorHandler) {
@@ -76,6 +79,7 @@ 
 	 * Handle method
 	 *
 	 * @param WSError Error
+	 * @return void
 	 */
 	public function handle($error);
 }
@@ -102,7 +106,7 @@ 
 	 * Verifies the API key
 	 *
 	 * @param string Secret key
-	 * @return mixed WSError in case of failure, null in case of success
+	 * @return WSCMError|null WSError in case of failure, null in case of success
 	 */
 	protected function verifyKey($secret_key) {
 		$ip = trim($_SERVER['REMOTE_ADDR']);