chamilo / chamilo-lms

main/inc/lib/phpseclib/Net/SSH2.php

Doc Comments +10 added lines, -13 removed lines

@@ -735,7 +735,7 @@ 
      * @param String $host
      * @param optional Integer $port
      * @param optional Integer $timeout
-     * @return Net_SSH2
+     * @return null|false
      * @access public
      */
     function Net_SSH2($host, $port = 22, $timeout = 10)
@@ -1588,9 +1588,7 @@ 
      * The $password parameter can be a plaintext password, a Crypt_RSA object or an array
      *
      * @param String $username
-     * @param Mixed $password
-     * @param Mixed $...
-     * @return Boolean
+     * @return boolean|null
      * @see _login_helper
      * @access public
      */
@@ -1614,7 +1612,7 @@ 
      *
      * @param String $username
      * @param optional String $password
-     * @return Boolean
+     * @return boolean|null
      * @access private
      * @internal It might be worthwhile, at some point, to protect against {@link http://tools.ietf.org/html/rfc4251#section-9.3.9 traffic analysis}
      *           by sending dummy SSH_MSG_IGNORE messages.
@@ -1779,7 +1777,6 @@ 
     /**
      * Handle the keyboard-interactive requests / responses.
      *
-     * @param String $responses...
      * @return Boolean
      * @access private
      */
@@ -1896,7 +1893,6 @@ 
      * Login with an RSA private key
      *
      * @param String $username
-     * @param Crypt_RSA $password
      * @return Boolean
      * @access private
      * @internal It might be worthwhile, at some point, to protect against {@link http://tools.ietf.org/html/rfc4251#section-9.3.9 traffic analysis}
@@ -2131,7 +2127,7 @@ 
      *
      * @see Net_SSH2::read()
      * @see Net_SSH2::write()
-     * @return Boolean
+     * @return boolean|null
      * @access private
      */
     function _initShell()
@@ -2427,6 +2423,7 @@ 
      * Because some binary packets need to be ignored...
      *
      * @see Net_SSH2::_get_binary_packet()
+     * @param string $payload
      * @return String
      * @access private
      */
@@ -2556,7 +2553,7 @@ 
      *
      * Returns the data as a string if it's available and false if not.
      *
-     * @param $client_channel
+     * @param integer $client_channel
      * @return Mixed
      * @access private
      */
@@ -2795,8 +2792,9 @@ 
      *
      * Makes sure that only the last 1MB worth of packets will be logged
      *
-     * @param String $data
      * @access private
+     * @param string $message_number
+     * @param string $message
      */
     function _append_log($message_number, $message)
     {
@@ -2894,7 +2892,7 @@ 
      * for SCP more than anything.
      *
      * @param Integer $client_channel
-     * @return Boolean
+     * @return boolean|null
      * @access private
      */
     function _close_channel($client_channel)
@@ -2920,7 +2918,7 @@ 
      * Disconnect
      *
      * @param Integer $reason
-     * @return Boolean
+     * @return false|null
      * @access private
      */
     function _disconnect($reason)
@@ -2958,7 +2956,6 @@ 
      * named constants from it, using the value as the name of the constant and the index as the value of the constant.
      * If any of the constants that would be defined already exists, none of the constants will be defined.
      *
-     * @param Array $array
      * @access private
      */
     function _define_array()

main/inc/lib/plugin.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -143,7 +143,7 @@ 
 
     /**
      * Returns the contents of the CSS defined by the plugin
-     * @return array
+     * @return string
      */
     public function get_css()
     {
@@ -161,7 +161,7 @@ 
 
     /**
      * Returns an HTML form (generated by FormValidator) of the plugin settings
-     * @return string FormValidator-generated form
+     * @return FormValidator FormValidator-generated form
      */
     public function get_settings_form()
     {
@@ -383,7 +383,7 @@ 
      * @param boolean $add_tool_link Whether to add a tool link or not
      * (some tools might just offer a configuration section and act on the backend)
      *
-     * @return boolean  False on error, null otherwise
+     * @return boolean|null  False on error, null otherwise
      */
     public function install_course_fields($courseId, $add_tool_link = true)
     {
@@ -491,7 +491,7 @@ 
      * tool on the course's homepage
      * @param int $courseId
      *
-     * @return void
+     * @return false|null
      */
     public function uninstall_course_fields($courseId)
     {
@@ -596,7 +596,7 @@ 
     * @param string   $tabName
     * @param string   $url
     *
-    * @return boolean
+    * @return false|string
     */
     public function addTab($tabName, $url)
     {

main/inc/lib/plugin.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -626,7 +626,7 @@
 
     /**
      * Get first SMS plugin name
-     * @return string|boolean
+     * @return string|false
      */
     public function getSMSPluginName()
     {

main/inc/lib/portfolio.class.php

Doc Comments +7 added lines, -3 removed lines

@@ -126,6 +126,7 @@ 
      * Returns a temporary url to download files and/or folders.
      *
      * @param string|array $ids
+     * @param string $tool
      * @return string
      */
     public static function download_url($ids, $tool)
@@ -293,7 +294,7 @@ 
     /**
      * The name of the porfolio where to send.
      *
-     * @return type
+     * @return string
      */
     function get_portfolio()
     {
@@ -391,7 +392,6 @@ 
      * Create a "send to portfolio" button
      *
      * @param string $tool          The name of the tool: document, work.
-     * @param int $c_id             The id of the course
      * @param int $id               The id of the object
      * @param array $attributes     Html attributes
      * @return \PortfolioShare
@@ -405,7 +405,7 @@ 
     /**
      * Returns the current secuirty token. Used to avoid see surfing attacks.
      *
-     * @return type
+     * @return string
      */
     static function security_token()
     {
@@ -420,6 +420,10 @@ 
     protected $attributes = array();
     protected $tool = '';
 
+    /**
+     * @param string $tool
+     * @param integer $id
+     */
     function __construct($tool, $id, $attributes = array())
     {
         $this->tool = $tool;

main/inc/lib/promotion.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -129,7 +129,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_status_list()
     {
@@ -272,7 +272,7 @@ 
     /**
      * @param int $id
      *
-     * @return bool
+     * @return null|false
      */
     public function delete($id)
     {

main/inc/lib/rights.lib.php

Doc Comments +4 added lines

@@ -15,6 +15,10 @@
 
 	// warning the goal of this function is to enforce rights managment in Chamilo
 	// thus default return value is always true
+
+	/**
+	 * @param string $handler
+	 */
 	public static function hasRight($handler) {
 		if (array_key_exists($handler, self::$rights_cache))
 			return self::$rights_cache[$handler];

main/inc/lib/search/ChamiloIndexer.class.php

Doc Comments +4 added lines

@@ -71,6 +71,10 @@
 
     /**
      * Get the terms stored at database
+     * @param string $prefix
+     * @param string $course_code
+     * @param string $tool_id
+     * @param integer $ref_id
      * @return  array Array of terms
      */
     function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id) {

main/inc/lib/search/ChamiloQuery.php

Doc Comments +4 added lines, -1 removed lines

@@ -23,6 +23,9 @@ 
     return chamilo_preprocess_results($results);
 }
 
+/**
+ * @param string $query_string
+ */
 function chamilo_query_simple_query($query_string, $offset=0, $length=10, $extra=NULL) {
     return xapian_query($query_string, NULL, $offset, $length, $extra);
 }
@@ -30,7 +33,7 @@ 
 /**
  * Wrapper for getting boolean queries
  *
- * @param   string    $query_string   The term string
+ * @param string $term
  */
 function chamilo_get_boolean_query($term) {
   return xapian_get_boolean_query($term);

main/inc/lib/search/IndexableChunk.class.php

Doc Comments +3 added lines

@@ -57,6 +57,7 @@ 
      * Add a value to the indexed item
      * @param  string  Key
      * @param  string  Value
+     * @param string $key
      * @return  void
      */
     function addValue($key, $value) {
@@ -101,6 +102,7 @@ 
 
     /**
      * Let add course id term
+     * @param string $course_id
      */
     public function addCourseId($course_id)
     {
@@ -109,6 +111,7 @@ 
 
     /**
      * Let add tool id term
+     * @param string $tool_id
      */
     public function addToolId($tool_id)
     {