EGroupware / egroupware

admin/inc/class.admin_ui.inc.php

Doc Comments +4 added lines

@@ -491,6 +491,10 @@
 	protected static function call_hook()
 	{
 		self::$hook_data = array();
+
+		/**
+		 * @param string $appname
+		 */
 		function display_section($appname,$file,$file2=False)
 		{
 			admin_ui::$hook_data[$appname] = $file2 ? $file2 : $file;

api/src/Acl.php

Doc Comments +3 added lines, -3 removed lines

@@ -166,7 +166,7 @@ 
 	 * Delete ACL record in the repository of the class
 	 *
 	 * @param string $appname appname or '' for $GLOBALS['egw_info']['flags']['currentapp']
-	 * @param string/boolean $location location or false for all locations
+	 * @param boolean $location location or false for all locations
 	 * @return array all ACL records from $this->data.
 	 */
 	function delete($appname,$location)
@@ -267,8 +267,8 @@ 
 	/**
 	 * check required rights agains the internal repository (included rights of $this->account_id and all it's memberships)
 	 *
-	 * @param $location app location
-	 * @param $required required right to check against
+	 * @param string $location app location
+	 * @param integer $required required right to check against
 	 * @param $appname optional defaults to currentapp
 	 * @return boolean
 	 */

api/src/Asyncservice.php

Doc Comments +3 added lines, -3 removed lines

@@ -324,7 +324,7 @@ 
 	 * cancels a timer
 	 *
 	 * @param string $id has to be the one used to set it.
-	 * @return boolean True if the timer exists and is not expired.
+	 * @return integer True if the timer exists and is not expired.
 	 */
 	function cancel_timer($id)
 	{
@@ -470,7 +470,7 @@ 
 	/**
 	 * reads all matching db-rows / jobs
 	 *
-	 * @param string $id =0 reads all expired rows / jobs ready to run\
+	 * @param integer $id =0 reads all expired rows / jobs ready to run\
 	 * 	!= 0 reads all rows/jobs matching $id (sql-wildcards '%' and '_' can be used)
 	 * @param array|string $cols ='*' string or array of column-names / select-expressions
 	 * @param int|bool $offset =False offset for a limited query or False (default)
@@ -558,7 +558,7 @@ 
 	/**
 	 * delete db-row / job with $id
 	 *
-	 * @return boolean False if $id not found else True
+	 * @return integer False if $id not found else True
 	 */
 	function delete($id)
 	{

api/src/Auth.php

Doc Comments +5 added lines, -4 removed lines

@@ -84,8 +84,8 @@ 
 	 * check if users are supposed to change their password every x sdays, then check if password is of old age
 	 * or the devil-admin reset the users password and forced the user to change his password on next login.
 	 *
-	 * @param string& $message =null on return false: message why password needs to be changed
-	 * @return boolean true: all good, false: password change required, null: password expires in N days
+	 * @param string $message =null on return false: message why password needs to be changed
+	 * @return boolean|null true: all good, false: password change required, null: password expires in N days
 	 */
 	static function check_password_change(&$message=null)
 	{
@@ -294,7 +294,7 @@ 
 	 *
 	 * uses the encryption type set in setup and calls the appropriate encryption functions
 	 *
-	 * @param $password password to encrypt
+	 * @param string $password password to encrypt
 	 */
 	static function encrypt_password($password,$sql=False)
 	{
@@ -406,6 +406,7 @@ 
 	 * @param string $form_val user input value for comparison
 	 * @param string $db_val   stored value / hash (from database)
 	 * @param string &$type    detected crypt type on return
+	 * @param string $type
 	 * @return boolean	 True on successful comparison
 	*/
 	static function crypt_compare($form_val, $db_val, &$type)
@@ -618,7 +619,7 @@ 
 	 * @param string $forbid_name =null if "yes" username or full-name split by delimiters AND longer then 3 chars are
 	 *  forbidden to be included in password, default to whatever set in config for "passwd_forbid_name"
 	 * @param array|int $account =null array with account_lid and account_fullname or account_id for $forbid_name check
-	 * @return mixed false if password is considered "safe" (or no requirements) or a string $message if "unsafe"
+	 * @return string|false false if password is considered "safe" (or no requirements) or a string $message if "unsafe"
 	 */
 	static function crackcheck($passwd, $reqstrength=null, $minlength=null, $forbid_name=null, $account=null)
 	{

api/src/CalDAV/PropfindIterator.php

Doc Comments +1 added lines

@@ -94,6 +94,7 @@
 	 * @param Handler $handler
 	 * @param array $filter filter for propfind call
 	 * @param array $files =array() extra files/responses to return too
+	 * @param string $path
 	 */
 	public function __construct(Handler $handler, $path, array $filter,array &$files=array())
 	{

api/src/Categories.php

Doc Comments +6 added lines, -6 removed lines

@@ -322,13 +322,13 @@ 
 	 * return a sorted array populated with categories (main sorting criteria is hierachy!)
 	 *
 	 * @param int $start =0 see $limit
-	 * @param boolean|int $limit if true limited query to maxmatches rows (starting with $start)
+	 * @param boolean $limit if true limited query to maxmatches rows (starting with $start)
 	 * @param string $query ='' query-pattern
 	 * @param string $sort ='ASC' sort order, either defaults to 'ASC'
 	 * @param string $order ='cat_name' order by
 	 * @param boolean|string $globals includes the global egroupware categories or not,
 	 * 	'all_no_acl' to return global and all non-private user categories independent of ACL
-	 * @param array|int $parent_id =0 return only subcats of $parent_id(s)
+	 * @param integer $parent_id =0 return only subcats of $parent_id(s)
 	 * @param boolean $unserialize_data =true return $cat['data'] as array (not serialized array)
 	 * @return array with cats
 	 */
@@ -507,7 +507,7 @@ 
 	 * @param mixed $category category as array or the category_id
 	 * @param boolean $no_acl_check =false if true, grants are NOT checked, gives access to all non-private categories of all users
 	 * @param boolean $allow_global_read if true, global cats are allowed (independent of app) for reading
-	 * @return boolean true permission granted, false for permission denied, null for category does not exist
+	 * @return null|boolean true permission granted, false for permission denied, null for category does not exist
 	 */
 	public function check_perms($needed, $category, $no_acl_check=false, $allow_global_read=false)
 	{
@@ -675,7 +675,7 @@ 
 	 * check_consistency4update - for edit
 	 *
 	 * @param array $values array with cat-data (it need to be complete, as everything get's written)
-	 * @return mixed string/boolean errorstring if consitency check failed / true if the consistency check did not fail
+	 * @return string|boolean string/boolean errorstring if consitency check failed / true if the consistency check did not fail
 	 */
 	function check_consistency4update($values)
 	{
@@ -822,7 +822,7 @@ 
 	 *
 	 * @param int|array $cat
 	 * @param boolean $application_global =false true check for application global categories only (appname == 'phpgw')
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	static function is_global($cat,$application_global=false)
 	{
@@ -1030,7 +1030,7 @@ 
 	 *
 	 * @param string appname
 	 *
-	 * @return Returns the URL, but you do not need to do anything with it.
+	 * @return string the URL, but you do not need to do anything with it.
 	 */
 	public static function css($appname)
 	{

api/src/Config.php

Doc Comments +1 added lines, -1 removed lines

@@ -194,7 +194,7 @@
 	/**
 	 * sets a single value in the repositry, you need to call save_repository after
 	 *
-	 * @param $variable_name string name of the config
+	 * @param string $variable_name string name of the config
 	 * @param $variable_data mixed the content
 	 */
 	function value($variable_name,$variable_data)

api/src/Contacts/Ads.php

Doc Comments -1 removed lines

@@ -213,7 +213,6 @@
 	/**
 	 * Remove attributes we are not allowed to update
 	 *
-	 * @param array $attributes
 	 */
 	function sanitize_update(array &$ldapContact)
 	{

api/src/Contacts/Sql.php

Doc Comments +2 added lines, -2 removed lines

@@ -250,7 +250,7 @@ 
 	 * For a union-query you call search for each query with $start=='UNION' and one more with only $order_by and $start set to run the union-query.
 	 *
 	 * @param array|string $criteria array of key and data cols, OR a SQL query (content for WHERE), fully quoted (!)
-	 * @param boolean|string|array $only_keys =true True returns only keys, False returns all cols. or
+	 * @param boolean|string $only_keys =true True returns only keys, False returns all cols. or
 	 *	comma seperated list or array of columns to return
 	 * @param string $order_by ='' fieldnames + {ASC|DESC} separated by colons ',', can also contain a GROUP BY (if it contains ORDER BY)
 	 * @param string|array $extra_cols ='' string or array of strings to be added to the SELECT, eg. "count(*) as num"
@@ -508,7 +508,7 @@ 
 	 * 	or whole where array: column-name => value(s) pairs
 	 * @param string $uid_column ='list_owner' column-name or null to use $uids as where array
 	 * @param string $member_attr =null null: no members, 'contact_uid', 'contact_id', 'caldav_name' return members as that attribute
-	 * @param boolean|int|array $limit_in_ab =false if true only return members from the same owners addressbook,
+	 * @param boolean $limit_in_ab =false if true only return members from the same owners addressbook,
 	 * 	if int|array only return members from the given owners addressbook(s)
 	 * @return array with list_id => array(list_id,list_name,list_owner,...) pairs
 	 */