chamilo / chamilo-lms

main/inc/lib/groupmanager.lib.php

Doc Comments +13 added lines, -10 removed lines

@@ -369,7 +369,7 @@ 
      * @author Christophe Gesche <christophe.gesche@claroline.net>
      * @author Hugues Peeters <hugues.peeters@claroline.net>
      * @author Bart Mollet
-     * @param  mixed  $groupIdList - group(s) to delete. It can be a single id
+     * @param  mixed  $group_ids - group(s) to delete. It can be a single id
      *                                (int) or a list of id (array).
      * @param string $course_code Default is current course
      * @return integer              - number of groups deleted.
@@ -573,7 +573,7 @@ 
      * @param bool      Whether self registration is allowed or not
      * @param bool      Whether self unregistration is allowed or not
      * @param int       $categoryId
-     * @return bool     TRUE if properties are successfully changed, false otherwise
+     * @return Statement|null     TRUE if properties are successfully changed, false otherwise
      */
     public static function set_group_properties(
         $group_id,
@@ -724,7 +724,7 @@ 
      * @param int $group_id The id of the group
      * @param string $course_code The course in which the group is (default =
      * current course)
-     * @return array The category
+     * @return integer The category
      */
     public static function get_category_from_group($group_id, $course_code = null)
     {
@@ -786,9 +786,9 @@ 
      * Create group category
      * @param string $title The title of the new category
      * @param string $description The description of the new category
-     * @param bool $self_registration_allowed
-     * @param bool $self_unregistration_allowed
-     * @param int $max_number_of_students
+     * @param integer $self_registration_allowed
+     * @param integer $self_unregistration_allowed
+     * @param int $maximum_number_of_students
      * @param int $groups_per_user
      */
     public static function create_category(
@@ -994,6 +994,8 @@ 
      * @param int $limit
      * @param bool $getCount
      * @param int $courseId
+     * @param string $column
+     * @param string $direction
      * @return array list of user id
      */
     public static function get_users(
@@ -1172,7 +1174,7 @@ 
      *         Hugues Peeters     <hugues.peeters@claroline.net> - original version
      * @author Roan Embrechts - virtual course support, code cleaning
      * @author Bart Mollet - code cleaning, use other GroupManager-functions
-     * @return void
+     * @return false|null
      */
     public static function fill_groups($group_ids)
     {
@@ -1625,7 +1627,7 @@ 
      * Unsubscribe user(s) from a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
      * @param int $group_id
-     * @return bool TRUE if successful
+     * @return boolean|null TRUE if successful
      */
     public static function unsubscribe_users($user_ids, $group_id)
     {
@@ -1644,7 +1646,7 @@ 
 
     /**
      * Unsubscribe all users from one or more groups
-     * @param mixed $group_id Can be an array with group-id's or a single group-id
+     * @param mixed $group_ids Can be an array with group-id's or a single group-id
      * @return bool TRUE if successful
      */
     public static function unsubscribe_all_users($group_ids)
@@ -1676,7 +1678,7 @@ 
 
     /**
      * Unsubscribe all tutors from one or more groups
-     * @param mixed $group_id Can be an array with group-id's or a single group-id
+     * @param mixed $group_ids Can be an array with group-id's or a single group-id
      * @see unsubscribe_all_users. This function is almost an exact copy of that function.
      * @return bool TRUE if successful
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1861,6 +1863,7 @@ 
      *
      * @param $user_array_in list of users (must be sorted).
      * @param string $compare_field, the field to be compared
+     * @param string $compare_field
      */
     public static function filter_duplicates($user_array_in, $compare_field)
     {

main/inc/lib/hook/HookManagement.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 
     /**
      * Return a list an associative array where keys are the active hook observer class name
-     * @param $eventName
+     * @param string $eventName
      *
      * @return array
      */

main/inc/lib/image.lib.php

Doc Comments +19 added lines

@@ -52,6 +52,9 @@ 
         }
     }
     
+    /**
+     * @param string|null $cropParameters
+     */
     public function crop($cropParameters) {
         $image_size = $this->get_image_size($this->image_wrapper->path);
         $src_width = $image_size['width'];
@@ -66,6 +69,9 @@ 
         return $image;
     }
 
+    /**
+     * @param string $convert_file_to
+     */
     public function send_image(
         $file = '',
         $compress = -1,
@@ -147,6 +153,9 @@ 
     public $image;
     public $filter = Imagick::FILTER_LANCZOS;
 
+    /**
+     * @param string $path
+     */
     public function __construct($path)
     {
           parent::__construct($path);
@@ -194,6 +203,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;
@@ -275,6 +288,9 @@ 
 {
     public $bg;
 
+    /**
+     * @param string $path
+     */
     function __construct($path) {
         parent::__construct($path);
     }
@@ -332,6 +348,9 @@ 
     	}
     }
 
+    /**
+     * @param integer $border
+     */
     public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
         if (!$this->image_validated) return false;

main/inc/lib/kses-0.2.2/kses_original.php

Doc Comments +9 added lines

@@ -408,6 +408,9 @@ 
 } # function kses_no_null
 
 
+/**
+ * @return string
+ */
 function kses_stripslashes($string)
 ###############################################################################
 # This function changes the character sequence  \"  to just  "
@@ -442,6 +445,9 @@ 
 } # function kses_array_lc
 
 
+/**
+ * @return string
+ */
 function kses_js_entities($string)
 ###############################################################################
 # This function removes the HTML JavaScript entities found in early versions of
@@ -506,6 +512,9 @@ 
 } # function kses_bad_protocol_once2
 
 
+/**
+ * @return string
+ */
 function kses_normalize_entities($string)
 ###############################################################################
 # This function normalizes HTML entities. It will convert "AT&T" to the correct

main/inc/lib/kses-0.2.2/oop/php4.class.kses.php

Doc Comments +3 added lines, -5 removed lines

@@ -431,7 +431,7 @@ 
 			 *
 			 *	@access public
 			 *	@param mixed , A string or array of protocols that will be removed from the internal list of allowed protocols.
-			 *	@return bool Status of removing valid protocols.
+			 *	@return null|boolean Status of removing valid protocols.
 			 *	@see RemoveProtocol()
 			 *	@since PHP5 OOP 0.2.1
 			 */
@@ -579,7 +579,7 @@ 
 			 *	This method goes through an array, and changes the keys to all lower case.
 			 *
 			 *	@access private
-			 *	@param array $in_array Associative array
+			 *	@param array $inarray Associative array
 			 *	@return array Modified array
 			 *	@since PHP4 OOP 0.0.1
 			 */
@@ -1129,9 +1129,7 @@ 
 			 *	URL protocol white listing system anyway.
 			 *
 			 *	@access private
-			 *	@param string $value The entitiy to be decoded.
-			 *	@return string Decoded entity
-			 *	@since PHP4 OOP 0.0.1
+			 * @param string $string
 			 */
 			function _decode_entities($string)
 			{

main/inc/lib/kses-0.2.2/oop/php5.class.kses.php

Doc Comments +2 added lines, -4 removed lines

@@ -321,7 +321,7 @@ 
 			 *
 			 *	@access public
 			 *	@param mixed , A string or array of protocols that will be removed from the internal list of allowed protocols.
-			 *	@return bool Status of removing valid protocols.
+			 *	@return null|boolean Status of removing valid protocols.
 			 *	@see RemoveProtocol()
 			 *	@since PHP5 OOP 1.0.0
 			 */
@@ -1133,9 +1133,7 @@ 
 			 *	URL protocol white listing system anyway.
 			 *
 			 *	@access private
-			 *	@param string $value The entitiy to be decoded.
-			 *	@return string Decoded entity
-			 *	@since PHP4 OOP 0.0.1
+			 * @param string $string
 			 */
 			private function decodeEntities($string)
 			{

main/inc/lib/kses-0.2.2/oop/test.oop.kses.php

Doc Comments +3 added lines

@@ -121,6 +121,9 @@
 		return $out;
 	}
 
+	/**
+	 * @param string $text
+	 */
 	function output_code_wrap($text)
 	{
 		if(KSESTEST_ENV == 'CLI')

main/inc/lib/login.lib.php

Doc Comments +2 added lines, -1 removed lines

@@ -266,6 +266,7 @@ 
      * @global bool   $is_platformAdmin
      * @global bool   $is_allowedCreateCourse
      * @global object $_user
+     * @param boolean $reset
      */
     public static function init_user($user_id, $reset)
     {
@@ -355,7 +356,7 @@ 
      * @global type $is_allowed_in_course
      *
      * @param type $course_id
-     * @param type $reset
+     * @param boolean $reset
      */
     static function init_course($course_id, $reset)
     {

main/inc/lib/model.lib.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
 
     /**
      * Useful finder - experimental akelos like only use in notification.lib.php send function
+     * @param string $type
      */
     public function find($type, $options = null)
     {