chamilo / chamilo-lms

main/inc/lib/formvalidator/FormValidator.class.php

Doc Comments +6 added lines, -6 removed lines

@@ -213,7 +213,7 @@ 
      * @param string $label
      * @param array $attributes
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addDatePicker($name, $label, $attributes = [])
     {
@@ -225,7 +225,7 @@ 
      * @param string $label
      * @param array $attributes
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addSelectLanguage($name, $label, $options = [], $attributes = [])
     {
@@ -237,7 +237,7 @@ 
      * @param string $label
      * @param array $attributes
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addDateTimePicker($name, $label, $attributes = [])
     {
@@ -700,7 +700,7 @@ 
      * @param array  $options
      * @param array  $attributes
      *
-     * @return HTML_QuickForm_radio
+     * @return HTML_QuickForm_group
      */
     public function addRadio($name, $label, $options = array(), $attributes = array())
     {
@@ -835,7 +835,7 @@ 
      * @param string $name
      * @param string $label
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addButtonAdvancedSettings($name, $label = '')
     {
@@ -932,7 +932,7 @@ 
     /**
      * This function has been created for avoiding changes directly within QuickForm class.
      * When we use it, the element is threated as 'required' to be dealt during validation.
-     * @param array $element					The array of elements
+     * @param array $elements					The array of elements
      * @param string $message					The message displayed
      */
     public function add_multiple_required_rule($elements, $message)

plugin/vchamilo/views/editinstance_form.php

Doc Comments +5 added lines, -5 removed lines

@@ -13,9 +13,9 @@ 
 
     /**
      * ChamiloForm constructor.
-     * @param $mode
-     * @param $returnurl
-     * @param $cancelurl
+     * @param string $mode
+     * @param string $returnurl
+     * @param string $cancelurl
      * @param $customdata
      */
     public function __construct($mode, $returnurl, $cancelurl, $customdata = [])
@@ -137,7 +137,7 @@ 
      * Check that form data is valid.
      * You should almost always use this, rather than {@see validate_defined_fields}
      *
-     * @return bool true if form data valid
+     * @return boolean|null true if form data valid
      */
     public function is_validated()
     {
@@ -166,7 +166,7 @@ 
      *                is NOT to validate the form when a no submit button has been pressed.
      *                pass true here to override this behaviour
      *
-     * @return bool true if form data valid
+     * @return boolean|null true if form data valid
      */
     public function validate_defined_fields($validateonnosubmit=false)
     {

main/template/default/auth/courses_categories.php

Doc Comments +2 added lines, -2 removed lines

@@ -428,7 +428,7 @@ 
  * @param $stok
  * @param $code
  * @param $search_term
- * @return html
+ * @return string
  */
 function return_register_button($course, $stok, $code, $search_term)
 {
@@ -443,7 +443,7 @@ 
  * @param $stok
  * @param $search_term
  * @param $code
- * @return html
+ * @return string
  */
 function return_unregister_button($course, $stok, $search_term, $code)
 {

main/inc/lib/userportal.lib.php

Doc Comments +8 added lines, -7 removed lines

@@ -657,6 +657,7 @@ 
     * retrieves all the courses that the user has already subscribed to
     * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
     * @param int $user_id: the id of the user
+    * @param integer $user_id
     * @return array an array containing all the information of the courses of the given user
     */
     public function get_courses_of_user($user_id)
@@ -707,13 +708,13 @@ 
 
     /**
      * @todo use the template system
-     * @param $title
-     * @param $content
+     * @param string|null $title
+     * @param string $content
      * @param string $id
      * @param array $params
      * @param string $idAccordion
      * @param string $idCollapse
-     * @return null|string
+     * @return string
      */
     public function show_right_block(
         $title,
@@ -937,7 +938,7 @@ 
     }
 
     /**
-     * @return null|string
+     * @return string
      */
     public function return_course_block()
     {
@@ -1590,8 +1591,8 @@ 
 
     /**
      * Return HTML code for personal user course category
-     * @param $id
-     * @param $title
+     * @param integer $id
+     * @param string $title
      * @return string
      */
     private static function getHtmlForUserCategory($id, $title)
@@ -1612,7 +1613,7 @@ 
     /**
      * return HTML code for course display in session view
      * @param array $courseInfo
-     * @param $userCategoryId
+     * @param integer $userCategoryId
      * @param bool $displayButton
      * @param $loadDirs
      * @return string

plugin/bbb/lib/bbb_plugin.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
     }
 
     /**
-     * @return BBBPlugin|null
+     * @return BBBPlugin
      */
     public static function create()
     {

main/inc/lib/image.lib.php

Doc Comments +16 added lines

@@ -63,6 +63,9 @@ 
         return $image;
     }
 
+    /**
+     * @param string $convert_file_to
+     */
     public function send_image(
         $file = '',
         $compress = -1,
@@ -144,6 +147,9 @@ 
     public $image;
     public $filter = Imagick::FILTER_LANCZOS;
 
+    /**
+     * @param string $path
+     */
     public function __construct($path)
     {
           parent::__construct($path);
@@ -191,6 +197,10 @@ 
 	}
 
 	//@todo implement border logic case for Imagick
+
+	/**
+	 * @param integer $border
+	 */
 	public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
 	    if (!$this->image_validated) return false;
@@ -272,6 +282,9 @@ 
 {
     public $bg;
 
+    /**
+     * @param string $path
+     */
     function __construct($path) {
         parent::__construct($path);
     }
@@ -329,6 +342,9 @@ 
     	}
     }
 
+    /**
+     * @param integer $border
+     */
     public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
         if (!$this->image_validated) return false;

plugin/vchamilo/lib.php

Doc Comments +20 added lines, -1 removed lines

@@ -128,7 +128,7 @@ 
 /**
 * provides a side connection to a vchamilo database
 * @param array $vchamilo
-* @return a connection
+* @return null|Doctrine\DBAL\Connection connection
 */
 function vchamilo_boot_connection(&$_configuration)
 {
@@ -608,6 +608,9 @@ 
     }
 }
 
+/**
+ * @param string $path
+ */
 function chop_last_slash($path)
 {
     return preg_replace('/\/$/', '', $path);
@@ -766,6 +769,9 @@ 
     return $str;
 }
 
+/**
+ * @param string $key
+ */
 function print_error($key, $component = '', $passthru = false, $extrainfo = ''){
     global $debuglevel;
     global $debugdisplay;
@@ -778,6 +784,10 @@ 
     ctrace('ERROR: '. $str);
 }
 
+/**
+ * @param string $message
+ * @param integer $level
+ */
 function debugging($message, $level) {
     global $debuglevel;
     global $debugdisplay;
@@ -790,6 +800,9 @@ 
     }
 }
 
+/**
+ * @param string $str
+ */
 function ctrace($str) {
     if (!defined('CLI_SCRIPT')) echo "<pre>";
     Display::addFlash(Display::return_message($str));
@@ -1073,6 +1086,9 @@ 
     die("Missing expected param $key in request input");
 }
 
+/**
+ * @param integer $default
+ */
 function optional_param($key, $default, $type = 0)
 {
     if (array_key_exists($key, $_REQUEST)) {
@@ -1083,6 +1099,9 @@ 
     return $default;
 }
 
+/**
+ * @param integer $type
+ */
 function param_filter_type($value, $type)
 {
     switch($type) {

main/inc/lib/pear/excelreader/OLERead.inc

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
 //echo $data[ROOT_START_BLOCK_POS];

 //function log

 

+/**
+ * @param integer $pos
+ */
 function GetInt4d($data, $pos)

 {

 	$value = ord($data[$pos]) | (ord($data[$pos+1])	<< 8) | (ord($data[$pos+2]) << 16) | (ord($data[$pos+3]) << 24);

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

Doc Comments +2 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
 	 *
 	 */
 	public function __construct($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
@@ -279,6 +280,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 +292,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();