EGroupware / egroupware

resources/inc/class.resources_bo.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -69,7 +69,6 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param int $user=null account_id of user to use for acl, default current user
 	 */
 	function __construct($user=null)
 	{
@@ -765,7 +764,7 @@ 
 	 *
 	 * Cornelius Weiss <egw@von-und-zu-weiss.de>
 	 * @param array $file array with key => value
-	 * @param int $resource_id
+	 * @param int $resouce_id
 	 * @return mixed string with msg if somthing went wrong; nothing if all right
 	 */
 	function save_picture($file,$resouce_id)

resources/inc/class.ui_acl.inc.php

Doc Comments +3 added lines

@@ -119,6 +119,9 @@
 		$template->pfp('out','acl',True);
 	}
 
+	/**
+	 * @param integer $right
+	 */
 	function selectlist($right,$users_only=false)
 	{
 		static $accountList;

setup/check_install.php

Doc Comments +1 added lines

@@ -313,6 +313,7 @@
  * Check if given package is installed via composer in EGroupware's vendor directory
  *
  * @param string $package package-name in composer notation eg. "pear-pear.horde.org/Horde_Imap_Client" or "pear-pear.php.net/Net_Sieve"
+ * @return string
  */
 function composer_check($package)
 {

setup/inc/class.setup.inc.php

Doc Comments +6 added lines, -6 removed lines

@@ -793,9 +793,9 @@ 
 
 	/**
 	 * egw version checking, is param 1 < param 2 in phpgw versionspeak?
-	 * @param	$a	phpgw version number to check if less than $b
-	 * @param	$b	phpgw version number to check $a against
-	 * @return	True if $a < $b
+	 * @param	string $a	phpgw version number to check if less than $b
+	 * @param	string $b	phpgw version number to check $a against
+	 * @return	boolean if $a < $b
 	 */
 	function alessthanb($a,$b,$DEBUG=False)
 	{
@@ -882,7 +882,7 @@ 
 	 *
 	 * @param	$a	phpgw version number to check if more than $b
 	 * @param	$b	phpgw version number to check $a against
-	 * @return	True if $a < $b
+	 * @return	boolean if $a < $b
 	 */
 	function amorethanb($a,$b,$DEBUG=False)
 	{
@@ -1152,7 +1152,7 @@ 
 	 *
 	 * Dont use it to set group-membership, use set_memberships instead!
 	 *
-	 * @param string|array $apps app-names
+	 * @param string $apps app-names
 	 * @param string $location eg. "run"
 	 * @param int|string $account accountid or account_lid
 	 * @param int $rights rights to set, default 1
@@ -1198,7 +1198,7 @@ 
 	/**
 	 * checks if one of the given tables exist, returns the first match
 	 *
-	 * @param array $tables array with possible table-names
+	 * @param string[] $tables array with possible table-names
 	 * @return string/boolean tablename or false
 	 */
 	function table_exist($tables,$force_refresh=False)

setup/inc/class.setup_cmd.inc.php

Doc Comments +4 added lines, -4 removed lines

@@ -85,7 +85,7 @@ 
 	/**
 	 * Saving the object to the database, reimplemented to not do it in setup context
 	 *
-	 * @param boolean $set_modifier=true set the current user as modifier or 0 (= run by the system)
+	 * @param boolean $set_modifier set the current user as modifier or 0 (= run by the system)
 	 * @return boolean true on success, false otherwise
 	 */
 	function save($set_modifier=true)
@@ -172,7 +172,7 @@ 
 	 *
 	 * @param string $user
 	 * @param string $pw
-	 * @param string $domain=null if given we also check agains config user/pw
+	 * @param string $domain if given we also check agains config user/pw
 	 * @throws egw_exception_no_permission(lang('Access denied: wrong username or password for manage-header !!!'),21);
 	 * @throws egw_exception_no_permission(lang("Access denied: wrong username or password to configure the domain '%1(%2)' !!!",$domain,$GLOBALS['egw_domain'][$domain]['db_type']),40);
 	 */
@@ -220,8 +220,8 @@ 
 	 * Sets self::$apps_to_update and self::$apps_to_install for the last/only domain only!
 	 *
 	 * @param string $domain='' domain to check, default '' = all
-	 * @param int/array $stop=0 stop checks before given exit-code(s), default 0 = all checks
-	 * @param boolean $verbose=false echo messages as they happen, instead returning them
+	 * @param int/array $stop stop checks before given exit-code(s), default 0 = all checks
+	 * @param boolean $verbose echo messages as they happen, instead returning them
 	 * @return array with translated messages
 	 */
 	static function check_installed($domain='',$stop=0,$verbose=false)

setup/inc/class.setup_cmd_admin.inc.php

Doc Comments +8 added lines, -10 removed lines

@@ -26,15 +26,13 @@ 
 	 * Constructor
 	 *
 	 * @param string|array $domain domain-name or array with all parameters
-	 * @param string $config_user=null user to config the domain (or header_admin_user)
-	 * @param string $config_passwd=null pw of above user
-	 * @param string $admin_user=null
-	 * @param string $admin_password=null
-	 * @param string $admin_firstname=null
-	 * @param string $admin_lastname=null
-	 * @param string $admin_email=null
-	 * @param array $config=array() extra config for the account object: account_repository, ldap_*
-	 * @param string $lang='en'
+	 * @param string $config_user user to config the domain (or header_admin_user)
+	 * @param string $config_passwd pw of above user
+	 * @param string $admin_user
+	 * @param string $admin_password
+	 * @param string $admin_firstname
+	 * @param string $admin_lastname
+	 * @param string $admin_email
 	 */
 	function __construct($domain,$config_user=null,$config_passwd=null,$admin_user=null,$admin_password=null,
 		$admin_firstname=null,$admin_lastname=null,$admin_email=null,array $config=array(),$lang='en')
@@ -61,7 +59,7 @@ 
 	/**
 	 * run the command: create eGW admin and standard groups
 	 *
-	 * @param boolean $check_only=false only run the checks (and throw the exceptions), but not the command itself
+	 * @param boolean $check_only only run the checks (and throw the exceptions), but not the command itself
 	 * @return string success message
 	 * @throws Exception(lang('Wrong credentials to access the header.inc.php file!'),2);
 	 * @throws Exception('header.inc.php not found!');

setup/inc/class.setup_cmd_database.inc.php

Doc Comments +9 added lines, -15 removed lines

@@ -39,16 +39,14 @@ 
 	 *
 	 * @param string/array $domain domain-name to customize the defaults or array with all parameters
 	 * @param string $db_type db-type (mysql, pgsql, ...)
-	 * @param string $db_host=null
-	 * @param string $db_port=null
-	 * @param string $db_name=null
-	 * @param string $db_user=null
-	 * @param string $db_pass=null
-	 * @param string $db_root=null
-	 * @param string $db_root_pw=null
-	 * @param string $sub_command='create_db' 'create_db', 'test_db', 'test_db_root'
-	 * @param string $db_grant_host='localhost' host/ip of webserver for grant
-	 * @param boolean $make_db_name_unique=false true: if create fails because db exists,
+	 * @param string $db_host
+	 * @param string $db_port
+	 * @param string $db_name
+	 * @param string $db_user
+	 * @param string $db_pass
+	 * @param string $db_root
+	 * @param string $db_root_pw
+	 * @param boolean $make_db_name_unique true: if create fails because db exists,
 	 * 	try creating a unique name by shortening the name and adding a number to it
 	 */
 	function __construct($domain,$db_type=null,$db_host=null,$db_port=null,$db_name=null,$db_user=null,$db_pass=null,
@@ -78,7 +76,7 @@ 
 	/**
 	 * run the command: test or create database
 	 *
-	 * @param boolean $check_only=false only run the checks (and throw the exceptions), but not the command itself
+	 * @param boolean $check_only only run the checks (and throw the exceptions), but not the command itself
 	 * @return string success message
 	 * @throws Exception(lang('Wrong credentials to access the header.inc.php file!'),2);
 	 * @throws Exception('header.inc.php not found!');
@@ -127,9 +125,6 @@ 
 	/**
 	 * Connect to database
 	 *
-	 * @param string $user=null default $this->db_user
-	 * @param string $pass=null default $this->db_pass
-	 * @param string $name=null default $this->db_name
 	 * @throws egw_exception_wrong_userinput Can not connect to database ...
 	 */
 	private function connect($user=null,$pass=null,$name=null)
@@ -267,7 +262,6 @@ 
 	/**
 	 * Return default database settings for a given domain
 	 *
-	 * @param string $db_type='mysql'
 	 * @return array
 	 */
 	static function defaults($db_type='mysqli')

setup/inc/class.setup_cmd_header.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -34,7 +34,7 @@ 
 	 * Constructor
 	 *
 	 * @param string/array $sub_command='create' 'create','edit','delete'(-domain) or array with all arguments
-	 * @param array $arguments=null comand line arguments
+	 * @param array $arguments comand line arguments
 	 */
 	function __construct($sub_command='create',$arguments=null)
 	{
@@ -66,7 +66,7 @@ 
 	/**
 	 * Create or update header.inc.php
 	 *
-	 * @param boolean $check_only=false only run the checks (and throw the exceptions), but not the command itself
+	 * @param boolean $check_only only run the checks (and throw the exceptions), but not the command itself
 	 * @return string serialized $GLOBALS defined in the header.inc.php
 	 * @throws Exception(lang('Wrong credentials to access the header.inc.php file!'),2);
 	 * @throws Exception('header.inc.php not found!');
@@ -155,7 +155,6 @@ 
 	 * Magic method to allow to call all methods from setup_header, as if they were our own
 	 *
 	 * @param string $method
-	 * @param array $args=null
 	 * @return mixed
 	 */
 	function __call($method,array $args=null)

setup/inc/class.setup_cmd_hooks.inc.php

Doc Comments +3 added lines, -4 removed lines

@@ -19,9 +19,8 @@ 
 	 * Constructor
 	 *
 	 * @param string $domain string with domain-name or array with all arguments
-	 * @param string $config_user=null user to config the domain (or header_admin_user)
-	 * @param string $config_passwd=null pw of above user
-	 * @param boolean $verbose=false if true, echos out some status information during the run
+	 * @param string $config_user user to config the domain (or header_admin_user)
+	 * @param string $config_passwd pw of above user
 	 */
 	function __construct($domain,$config_user=null,$config_passwd=null)
 	{
@@ -40,7 +39,7 @@ 
 	/**
 	 * run the command: register all hooks
 	 *
-	 * @param boolean $check_only=false only run the checks (and throw the exceptions), but not the command itself
+	 * @param boolean $check_only only run the checks (and throw the exceptions), but not the command itself
 	 * @return string success message
 	 * @throws Exception(lang('Wrong credentials to access the header.inc.php file!'),2);
 	 * @throws Exception('header.inc.php not found!');