chamilo / chamilo-lms

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()
 {

main/inc/lib/event_email_template.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
     /**
      * Available driver list.
-     * @return array
+     * @return string[]
      */
     private function getDefaultDriverList()
     {

main/inc/lib/events_dispatcher.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     }
 
     /**
-     * @return bool
+     * @return false|null
      */
     public function create_user_folder()
     {

main/inc/lib/extra_field_option.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -412,7 +412,7 @@ 
      * Gets an array of options for a specific field
      * @param int $field_id The field ID
      * @param bool $add_id_in_array Whether to add the row ID in the result
-     * @param null $ordered_by Extra ordering query bit
+     * @param null|string $ordered_by Extra ordering query bit
      * @return array The options if they exists. Otherwise return false
      */
     public function get_field_options_by_field($field_id, $add_id_in_array = false, $ordered_by = null)
@@ -782,8 +782,8 @@ 
     }
 
     /**
-     * @param $defaultDisplayText
-     * @return mixed|string
+     * @param string $defaultDisplayText
+     * @return string
      */
     public static function getLanguageVariable($defaultDisplayText)
     {