EGroupware / egroupware

api/src/Hooks.php

Doc Comments +1 added lines, -1 removed lines

@@ -254,7 +254,7 @@
 
 	/**
 	 * Static function to build pgp encryption sidebox menu
-	 * @param type $appname application name
+	 * @param string $appname application name
 	 */
 	public static function pgp_encryption_menu($appname)
 	{

api/src/Html.php

Doc Comments +3 added lines, -5 removed lines

@@ -139,7 +139,7 @@ 
 	 *
 	 * @param string $name	string with name of the submitted var which holds the key of the selected item form array
 	 * @param string|array $key key(s) of already selected item(s) from $arr, eg. '1' or '1,2' or array with keys
-	 * @param array $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
+	 * @param integer $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
 	 * @param boolean $no_lang NOT run the labels of the options through lang(), default false=use lang()
 	 * @param string $options additional options (e.g. 'width')
 	 * @param int $multiple number of lines for a multiselect, default 0 = no multiselect, < 0 sets size without multiple
@@ -227,7 +227,7 @@ 
 	 *
 	 * @param string $name	string with name of the submitted var which holds the key of the selected item form array
 	 * @param string|array $key key(s) of already selected item(s) from $arr, eg. '1' or '1,2' or array with keys
-	 * @param array $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
+	 * @param integer $arr array with items to select, eg. $arr = array ( 'y' => 'yes','n' => 'no','m' => 'maybe');
 	 * @param boolean $no_lang NOT run the labels of the options through lang(), default false=use lang()
 	 * @param string $options additional options (e.g. 'width')
 	 * @param int $multiple number of lines for a multiselect, default 3
@@ -313,7 +313,7 @@ 
 	 * @param string $value value
 	 * @param string $label label
 	 * @param mixed $selected value or array of values of options to mark as selected
-	 * @param boolean $no_lang NOT running the label through lang(), default false=use lang()
+	 * @param integer $no_lang NOT running the label through lang(), default false=use lang()
 	 * @param string $extra extra text, e.g.: style="", default: ''
 	 * @return string html
 	 */
@@ -386,7 +386,6 @@ 
 	 *
 	 * @param string $name name attr. of the tag
 	 * @param string $value default
-	 * @param boolean $ignore_empty if true all empty, zero (!) or unset values, plus filer=none
 	 * @param boolean $double_encoding =false do we want double encoding or not, default no
 	 * @param string html
 	 */
@@ -741,7 +740,6 @@ 
 	 * @param array $hidden_vars array with name-value pairs for hidden input fields
 	 * @param string $url eGW relative URL, will be run through the link function
 	 * @param string|array $url_vars parameters for the URL, send to link static function too
-	 * @param string $options attributes for the tag, default ''=none
 	 * @param string $form_name name of the form, defaul ''=none
 	 * @param string $method method of the form, default 'POST'
 	 * @return string html

api/src/Html/CkEditorConfig.php

Doc Comments +3 added lines, -3 removed lines

@@ -65,7 +65,7 @@ 
 	 *
 	 * Only return skins existing in filesystem, as we disable / remove them if not compatible with supported browsers.
 	 *
-	 * @return array skin => label pairs alphabetical sorted with default moono first
+	 * @return string skin => label pairs alphabetical sorted with default moono first
 	 */
 	public static function getAvailableCKEditorSkins()
 	{
@@ -259,7 +259,7 @@ 
 	 * Adds all "easy to write" options to the configuration
 	 *
 	 * @param array& $config array were config get's added to
-	 * @param int|string $height integer height in pixel or string with css unit
+	 * @param integer $height integer height in pixel or string with css unit
 	 * @param boolean|string $expanded_toolbar show toolbar expanded, boolean value, string "false", or string casted to boolean
 	 * @param string $start_path start path for file browser
 	 */
@@ -451,7 +451,7 @@ 
 	/**
 	 * Adds extra
 	 * @param array $config
-	 * @param array $plugins plugins name which needs to be appended into extraPlugins
+	 * @param string[] $plugins plugins name which needs to be appended into extraPlugins
 	 */
 	public static function append_extraPlugins_config_array (&$config, $plugins)
 	{

api/src/Html/HtmLawed.php

Doc Comments +1 added lines, -1 removed lines

@@ -104,7 +104,7 @@
 	 * @param varchar $html2check =text input Text to check
 	 * @param mixed $Config = text or array
 	 * @param mixed $Spec =text or array; The '$spec' argument can be used to disallow an otherwise legal attribute for an element
-	 * @return varchar cleaned/fixed html
+	 * @return string cleaned/fixed html
 	 */
 	function run($html2check, $Config=null, $Spec=array())
 	{

api/src/Html/htmLawed/htmLawed.php

Doc Comments +4 added lines

@@ -625,6 +625,10 @@
 // eof
 }
 
+/**
+ * @param string $e
+ * @param string $a
+ */
 function hl_tag2(&$e, &$a, $t=1){
 // transform tag
 if($e == 'center'){$e = 'div'; return 'text-align: center;';}

api/src/Json/Msg.php

Doc Comments +5 added lines, -3 removed lines

@@ -82,8 +82,7 @@ 
 	/**
 	 * Allows to call a global javascript function with given parameters: window[$func].call(window[, $param1[, ...]])
 	 *
-	 * @param string $func name of the global (window) javascript function to call
-	 * @param mixed $parameters variable number of parameters
+	 * @param string $function
 	 */
 	public function call($function)
 	{
@@ -108,7 +107,7 @@ 
 	 *
 	 * @param string $selector jquery selector
 	 * @param string $method name of the jquery to call
-	 * @param array $parameters =array()
+	 * @param string[] $parameters =array()
 	 */
 	public function jquery($selector,$method,array $parameters=array())
 	{
@@ -126,6 +125,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public function generic($type, array $parameters = array())
 	{
 		if (is_string($type))

api/src/Ldap/ServerInfo.php

Doc Comments +2 added lines, -2 removed lines

@@ -81,7 +81,7 @@ 
 	/**
 	* gets the version
 	*
-	* @return integer the supported ldap version
+	* @return string the supported ldap version
 	*/
 	function getVersion()
 	{
@@ -159,7 +159,7 @@ 
 	 * @param resource $ds
 	 * @param string $host
 	 * @param int $version 2 or 3
-	 * @return ldapserverinfo
+	 * @return ServerInfo
 	 */
 	public static function get($ds, $host, $version=3)
 	{

api/src/Link/Storage.php

Doc Comments +6 added lines, -1 removed lines

@@ -176,6 +176,11 @@ 
 		return is_array($id) ? $links : ($links[$id] ? $links[$id] : array());
 	}
 
+	/**
+	 * @param boolean $left
+	 * @param string $only_app
+	 * @param boolean $not_only
+	 */
 	private static function _add2links($row,$left,$only_app,$not_only,array &$links)
 	{
 		$linked_app = $left ? $row['link_app2'] : $row['link_app1'];
@@ -206,7 +211,7 @@ 
 	 * @param string $id ='' id in $app, if no integer link_id given in $app_link_id
 	 * @param string $app2 ='' appname of 2. endpoint of the link, if no integer link_id given in $app_link_id
 	 * @param string $id2 ='' id in $app2, if no integer link_id given in $app_link_id
-	 * @return array with link-data or False
+	 * @return string with link-data or False
 	 */
 	static function get_link($app_link_id,$id='',$app2='',$id2='')
 	{

api/src/Mail/Account.php

Doc Comments +6 added lines, -6 removed lines

@@ -486,7 +486,7 @@ 
 	 * @param boolean $replace_placeholders =false should placeholders like {{n_fn}} be replaced
 	 * @param string $field ='name' what to return as value: "ident_(realname|org|email|signature)" or default "name"=result from identity_name
 	 * @param int $user =null account_id to use if not current user
-	 * @return Iterator ident_id => identity_name of identity
+	 * @return Api\Db\CallbackIterator ident_id => identity_name of identity
 	 */
 	public static function identities($account, $replace_placeholders=true, $field='name', $user=null)
 	{
@@ -795,7 +795,7 @@ 
 	 *
 	 * To get $this->params you need to call getUserData before! It is never automatically loaded.
 	 *
-	 * @param type $name
+	 * @param string $name
 	 * @return mixed
 	 */
 	public function __get($name)
@@ -819,8 +819,8 @@ 
 	/**
 	 * Give read access to protected parameters in $this->params
 	 *
-	 * @param type $name
-	 * @return mixed
+	 * @param string $name
+	 * @return boolean
 	 */
 	public function __isset($name)
 	{
@@ -1340,10 +1340,10 @@ 
 	 * @param boolean|string $just_name =true true: return self::identity_name, false: return Account objects,
 	 *	string with attribute-name: return that attribute, eg. acc_imap_host or 'params' to return all attributes as array
 	 * @param string $order_by ='acc_name ASC'
-	 * @param int|boolean $offset =false offset or false to return all
+	 * @param boolean $offset =false offset or false to return all
 	 * @param int $num_rows =0 number of rows to return, 0=default from prefs (if $offset !== false)
 	 * @param boolean $replace_placeholders =true should placeholders like {{n_fn}} be replaced
-	 * @return Iterator with acc_id => acc_name or Account objects
+	 * @return Api\Db\CallbackIterator with acc_id => acc_name or Account objects
 	 */
 	public static function search($only_current_user=true, $just_name=true, $order_by=null, $offset=false, $num_rows=0, $replace_placeholders=true)
 	{