chamilo / chamilo-lms

main/lp/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/lp/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,

main/lp/lp_ajax_save_item.php

Doc Comments +3 added lines, -3 removed lines

@@ -20,9 +20,9 @@
  * @param   int $user_id User ID
  * @param   int $view_id View ID
  * @param   int $item_id Item ID
- * @param   float  $score Current score
- * @param   float  $max Maximum score
- * @param   float  $min Minimum score
+ * @param   integer  $score Current score
+ * @param   integer  $max Maximum score
+ * @param   integer  $min Minimum score
  * @param   string  $status Lesson status
  * @param   int  $time Session time
  * @param   string  $suspend Suspend data

main/lp/lp_ajax_start_timer.php

Doc Comments +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
 /**
  * Start a timer and hand it back to the JS by assigning the current time (of start) to
  * var asset_timer
- * @return string JavaScript time intializer
+ * @return integer JavaScript time intializer
  */
 function start_timer() {
     $time = time();

main/lp/lp_final_item.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
  * @param int $sessionId
  * @param string $downloadCertificateLink
  * @param string $badgeLink
- * @return mixed|string
+ * @return string
  */
 function generateLPFinalItemTemplate($lpItemId, $courseCode, $sessionId=0, $downloadCertificateLink='', $badgeLink='')
 {

main/lp/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/lp/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/lp/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/admin/settings.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -1154,7 +1154,7 @@ 
 /**
  * Returns an array containing the list of options used to populate the gradebook_number_decimals variable
  * This function is called through a call_user_func() in the generate_settings_form function.
- * @return array List of gradebook_number_decimals options
+ * @return string[] List of gradebook_number_decimals options
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
  */
@@ -1575,8 +1575,9 @@ 
 }
 /**
  * Helper function to generates a form elements group
- * @param object $form The form where the elements group has to be added
+ * @param FormValidator $form The form where the elements group has to be added
  * @param array $values Values to browse through
+ * @param string $elementName
  * @return array
  */
 function formGenerateElementsGroup($form, $values = array(), $elementName)
@@ -1592,7 +1593,7 @@ 
 }
 /**
  * Helper function with allowed file types for CSS
- * @return  array Array of file types (no indexes)
+ * @return  string[] Array of file types (no indexes)
  */
 function getAllowedFileTypes()
 {