EGroupware / egroupware

addressbook/inc/class.addressbook_contactform.inc.php

Doc Comments +11 added lines, -15 removed lines

@@ -30,14 +30,12 @@ 
 	/**
 	 * Shows the contactform and stores the submitted data
 	 *
-	 * @param array $content=null submitted eTemplate content
-	 * @param int $addressbook=null int owner-id of addressbook to save contacts too
-	 * @param array $fields=null field-names to show
-	 * @param string $msg=null message to show after submitting the form
-	 * @param string $email=null comma-separated email addresses
-	 * @param string $tpl_name=null custom etemplate to use
-	 * @param string $subject=null subject for email
-	 * @param string $copytoreceiver=false send a copy of notification to receiver
+	 * @param array $content submitted eTemplate content
+	 * @param int $addressbook int owner-id of addressbook to save contacts too
+	 * @param array $fields field-names to show
+	 * @param string $tpl_name custom etemplate to use
+	 * @param string $subject subject for email
+	 * @param string $copytoreceiver send a copy of notification to receiver
 	 * @return string html content
 	 */
 	function display(array $content=null,$addressbook=null,$fields=null,$msg=null,$email=null,$tpl_name=null,$subject=null,$copytoreceiver=false,$sel_options=array())
@@ -49,13 +47,11 @@ 
 	 * Shows the contactform and stores the submitted data ($content is a var parameter, eg. for extending classes)
 	 *
 	 * @param array &$content=null submitted eTemplate content
-	 * @param int $addressbook=null int owner-id of addressbook to save contacts too
-	 * @param array $fields=null field-names to show
-	 * @param string $msg=null message to show after submitting the form
-	 * @param string $email=null comma-separated email addresses
-	 * @param string $tpl_name=null custom etemplate to use
-	 * @param string $subject=null subject for email
-	 * @param string $copytoreceiver=false send a copy of notification to receiver
+	 * @param int $addressbook int owner-id of addressbook to save contacts too
+	 * @param array $fields field-names to show
+	 * @param string $tpl_name custom etemplate to use
+	 * @param string $subject subject for email
+	 * @param string $copytoreceiver send a copy of notification to receiver
 	 * @return string html content
 	 */
 	function display_var(array &$content=null,$addressbook=null,$fields=null,$msg=null,$email=null,$tpl_name=null,$subject=null,$copytoreceiver=false,$sel_options=array())

addressbook/inc/class.addressbook_export_contacts_csv.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
 	/**
 	 * Exports records as defined in $_definition
 	 *
-	 * @param egw_record $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function export( $_stream, importexport_definition $_definition) {
 

addressbook/inc/class.addressbook_favorite_portlet.inc.php

Doc Comments -2 removed lines

@@ -79,8 +79,6 @@
 	 * Here we need to handle any incoming data.  Setup is done in the constructor,
 	 * output is handled by parent.
 	 *
-	 * @param type $id
-	 * @param Etemplate $etemplate
 	 */
 	public static function process($values = array())
 	{

addressbook/inc/class.addressbook_groupdav.inc.php

Doc Comments +5 added lines, -5 removed lines

@@ -106,7 +106,7 @@ 
 	 * @param array &$files
 	 * @param int $user account_id
 	 * @param string $id =''
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function propfind($path,&$options,&$files,$user,$id='')
 	{
@@ -188,7 +188,7 @@ 
 	 *
 	 * @param string $path
 	 * @param array& $filter
-	 * @param array|boolean $start =false false=return all or array(start,num)
+	 * @param integer[] $start =false false=return all or array(start,num)
 	 * @return array with "files" array with values for keys path and props
 	 */
 	function &propfind_callback($path,array &$filter,$start=false,$report_not_found_multiget_ids=true)
@@ -539,7 +539,7 @@ 
 	 * @param array &$options
 	 * @param int $id
 	 * @param int $user =null account_id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function get(&$options,$id,$user=null)
 	{
@@ -566,7 +566,7 @@ 
 	 * @param int $id
 	 * @param int $user =null account_id of owner, default null
 	 * @param string $prefix =null user prefix from path (eg. /ralf from /ralf/addressbook)
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return string|boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function put(&$options,$id,$user=null,$prefix=null)
 	{
@@ -1024,7 +1024,7 @@ 
 	 *
 	 * @param int $acl Acl::READ, Acl::EDIT or Acl::DELETE
 	 * @param array|int $contact contact-array or id
-	 * @return boolean null if entry does not exist, false if no access, true if access permitted
+	 * @return null|boolean null if entry does not exist, false if no access, true if access permitted
 	 */
 	function check_access($acl,$contact)
 	{

addressbook/inc/class.addressbook_import_contacts_csv.inc.php

Doc Comments +2 added lines, -4 removed lines

@@ -44,9 +44,7 @@ 
 
 	/**
 	 * imports entries according to given definition object.
-	 * @param resource $_stream
-	 * @param string $_charset
-	 * @param definition $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function init(importexport_definition &$_definition ) {
 
@@ -84,7 +82,7 @@ 
 	 *
 	 * Updates the count of actions taken
 	 *
-	 * @return boolean success
+	 * @return null|boolean success
 	 */
 	protected function import_record(importexport_iface_egw_record &$record, &$import_csv)
 	{

addressbook/inc/class.addressbook_import_vcard.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -83,8 +83,7 @@
 	/**
 	 * imports entries according to given definition object.
 	 * @param resource $_stream
-	 * @param string $_charset
-	 * @param definition $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function import( $_stream, importexport_definition $_definition ) {
 		$this->definition = $_definition;

admin/admin-cli.php

Doc Comments -1 removed lines

@@ -532,7 +532,6 @@
 /**
  * Read the IMAP ACLs
  *
- * @param array $args admin-account[@domain],admin-password,accout_lid[,pw]
  * @return int 0 on success
  */
 function do_subscribe_other($account_lid,$pw=null)

admin/inc/class.admin_accesslog.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -255,11 +255,10 @@
 	 *
 	 * @param type $action
 	 * @param type $checked
-	 * @param type $use_all
 	 * @param type $success
 	 * @param int $failed
 	 * @param type $action_msg
-	 * @return type number of failed
+	 * @return boolean number of failed
 	 */
 	function action($action,$checked,&$success,&$failed,&$action_msg)
 	{

admin/inc/class.admin_categories.inc.php

Doc Comments +2 added lines

@@ -679,6 +679,8 @@
 	 * @param int &$failed number of failed actions (not enought permissions)
 	 * @param string &$action_msg translated verb for the actions, to be used in a message like '%1 entries deleted'
 	 * @param array $query get_rows parameter
+	 * @param integer $success
+	 * @param integer $failed
 	 * @return boolean true if all actions succeded, false otherwise
 	 */
 	function action($_action, $checked, $use_all, &$success, &$failed, &$action_msg, array $query)