chamilo / chamilo-lms

main/inc/lib/xajax/xajax.inc.php

Doc Comments +2 added lines, -1 removed lines

@@ -500,7 +500,7 @@ 
 	 * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if
 	 * there is none.
 	 *
-	 * @return mixed
+	 * @return integer
 	 */
 	function getRequestMode()
 	{
@@ -1018,6 +1018,7 @@ 
 	 *
 	 * @param string the root tag of the XML
 	 * @param string XML to convert
+	 * @param string $rootTag
 	 * @access private
 	 * @return array
 	 */

main/inc/lib/xajax/xajaxCompress.php

Doc Comments +1 added lines

@@ -39,6 +39,7 @@
  * (used internally)
  *
  * @param string contains the Javascript code to compress
+ * @param string $sJS
  */
 function xajaxCompressJavascript($sJS)
 {

main/inc/lib/xajax/xajaxResponse.inc.php

Doc Comments +4 added lines, -2 removed lines

@@ -97,6 +97,7 @@ 
 	 * @param string  contains the character encoding string to use
 	 * @param boolean lets you set if you want special characters in the output
 	 *                converted to HTML entities
+	 * @param string $sEncoding
 	 *
 	 */
 	function xajaxResponse($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
@@ -223,6 +224,8 @@ 
 	 * @param string contains the id of an HTML element
 	 * @param string the part of the element you wish to clear ("innerHTML",
 	 *               "value", etc.)
+	 * @param string $sTarget
+	 * @param string $sAttribute
 	 */
 	function addClear($sTarget,$sAttribute)
 	{
@@ -279,6 +282,7 @@ 
 	 * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd>
 	 *
 	 * @param string contains Javascript code to be executed
+	 * @param string $sJS
 	 */
 	function addScript($sJS)
 	{
@@ -290,8 +294,6 @@ 
 	 *
 	 * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd>
 	 *
-	 * @param string $sFunc the name of a Javascript function
-	 * @param mixed $args,... optional arguments to pass to the Javascript function
 	 */
 	function addScriptCall() {
 		$arguments = func_get_args();

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/newscorm/aicc.class.php

Doc Comments +5 added lines, -3 removed lines

@@ -216,7 +216,7 @@ 
     /**
      * Import the aicc object (as a result from the parse_config_files function) into the database structure
      * @param	string	$course_code
-     * @return	bool	Returns -1 on error
+     * @return	false|null	Returns -1 on error
      */
     public function import_aicc($course_code)
     {
@@ -780,7 +780,8 @@ 
      * Static function to parse AICC ini files.
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param	string	File path
-     * @return	array	Structured array
+     * @param string $f
+     * @return	string	Structured array
      */
     function parse_ini_file_quotes_safe($f) {
         $null = '';
@@ -831,7 +832,7 @@ 
      * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
      * @param		string	INI File string
      * @param		array	List of names of sections that should be considered as containing only hard string data (no variables), provided in lower case
-     * @return	array	Structured array
+     * @return	string	Structured array
      */
     function parse_ini_string_quotes_safe($s, $pure_strings = array()) {
         $null = '';
@@ -894,6 +895,7 @@ 
      * @param	string	CSV delimiter
      * @param	string	CSV enclosure
      * @param	boolean	Might one field name happen more than once on the same line? (then split by comma in the values)
+     * @param string $f
      * @return array	Simple structured array
      */
     function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false) {

main/newscorm/learnpath_functions.inc.php

Doc Comments +1 added lines

@@ -60,6 +60,7 @@
 /**
  * This function deletes an entire directory
  * @param	string	The directory path
+ * @param string $dir
  * @return boolean	True on success, false on failure
  */
 function deldir($dir) {

main/newscorm/learnpathItem.class.php

Doc Comments +6 added lines, -6 removed lines

@@ -1869,7 +1869,7 @@ 
 
     /**
      * Get the extra terms (tags) that identify this item
-     * @return mixed
+     * @return string
      */
     public function get_terms()
     {
@@ -2069,7 +2069,7 @@ 
 
     /**
      * Opens/launches the item. Initialises runtime values.
-     * @return    boolean    True on success, false on failure.
+     * @return    boolean|null    True on success, false on failure.
      */
     public function open($allow_new_attempt = false)
     {
@@ -3494,7 +3494,7 @@ 
 
     /**
      * Checks if the current status is part of the list of status given
-     * @param  array  $list  An array of status to check for.
+     * @param  string[]  $list  An array of status to check for.
      * If the current status is one of the strings, return true
      *
      * @return boolean True if the status was one of the given strings,
@@ -3671,7 +3671,7 @@ 
     /**
      * Write objectives to DB. This method is separate from write_to_db() because otherwise
      * objectives are lost as a side effect to AJAX and session concurrent access
-     * @return    boolean        True or false on error
+     * @return    boolean|null        True or false on error
      */
     public function write_objectives_to_db()
     {
@@ -4312,7 +4312,7 @@ 
      * Removes the relation between the current item and an audio file. The file
      * is only removed from the lp_item table, but remains in the document table
      * and directory
-     * @return bool
+     * @return false|null
      */
     public function remove_audio()
     {
@@ -4333,7 +4333,7 @@ 
      * @param $status
      * @param bool $decorate
      * @param string $type classic|simple
-     * @return array|string
+     * @return string
      */
     static function humanize_status($status, $decorate = true, $type = 'classic')
     {

main/newscorm/learnpathList.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * @param   int     $categoryId
      * @param bool $ignoreCategoryFilter
      *
-     * @return	void
+     * @return	false|null
      */
     public function __construct(
         $user_id,