chamilo / chamilo-lms

main/inc/lib/VideoChat.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      * Create a video chat
      * @param int $fromUser The sender user
      * @param int $toUser The receiver user
-     * @return int The created video chat id. Otherwise return false
+     * @return false|string The created video chat id. Otherwise return false
      */
     public static function createRoom($fromUser, $toUser)
     {

main/inc/lib/zombie/zombie_report.class.php

Doc Comments +3 added lines

@@ -121,6 +121,9 @@
         return $form->isSubmitted() == false || $form->validate();
     }
 
+    /**
+     * @param string $format
+     */
     function get_ceiling($format = null)
     {
         $result = Request::get('ceiling');

main/install/install.lib.php

Doc Comments +14 added lines, -5 removed lines

@@ -97,7 +97,7 @@ 
  * This function return the value of a php.ini setting if not "" or if exists,
  * otherwise return false
  * @param   string  $phpSetting The name of a PHP setting
- * @return  mixed   The value of the setting, or false if not found
+ * @return  string|false   The value of the setting, or false if not found
  */
 function checkPhpSettingExists($phpSetting)
 {
@@ -1268,6 +1268,10 @@ 
  * @param   string  Extra notice (to show on the right side)
  * @param   boolean Whether to display in update mode
  * @param   string  Additional attribute for the <tr> element
+ * @param string $installType
+ * @param string $parameterName
+ * @param string $formFieldName
+ * @param string $extra_notice
  * @return  void    Direct output
  */
 function displayDatabaseParameter(
@@ -1481,6 +1485,11 @@ 
 
     <?php
 }
+/**
+ * @param string $content
+ * @param string $title
+ * @param string $id
+ */
 function panel($content = null, $title = null, $id = null, $style = null) {
     $html = '';
     if (empty($style)) {
@@ -1837,8 +1846,8 @@ 
 }
 
 /**
- * @param $current_value
- * @param $wanted_value
+ * @param string $current_value
+ * @param string $wanted_value
  * @return string
  */
 function compare_setting_values($current_value, $wanted_value)
@@ -1855,8 +1864,8 @@ 
 }
 
 /**
- * @param $course_dir
- * @param $course_attempt_name
+ * @param string $course_dir
+ * @param string $course_attempt_name
  * @param string $file
  * @return bool
  */

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/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']);

main/webservices/cm_webservice_inbox.php

Doc Comments +3 added lines

@@ -204,6 +204,9 @@
 
     }
 
+    /**
+     * @param integer $user_id
+     */
     protected function set_message_as_read($user_id, $message_id){
         $table_message = Database::get_main_table(TABLE_MESSAGE);
         $query = "UPDATE $table_message SET msg_status = '".MESSAGE_STATUS_NEW."' WHERE user_receiver_id=".$user_id." AND id='".$message_id."';";

main/webservices/cm_webservice_user.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
     /**
     * Get a list of users of which the given conditions match with a LIKE '%cond%'
     * @param array $conditions a list of condition (exemple : status=>STUDENT)
-    * @param array $order_by a list of fields on which sort
+    * @param string[] $order_by a list of fields on which sort
     * @return array An array with all users of the platform.
     * @todo optional course code parameter, optional sorting parameters...
      *@todo Use the UserManager class