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_hooks.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -423,7 +423,7 @@ 
 	 * Register addressbook for group-acl
 	 *
 	 * @param array $args hook-params (not used)
-	 * @return boolean|string true=standard group acl link, of string with link
+	 * @return boolean true=standard group acl link, of string with link
 	 */
 	static function group_acl($args)
 	{
@@ -437,7 +437,7 @@ 
 	 * For which groups should no group acl be used: addressbook always
 	 *
 	 * @param string|array $data
-	 * @return boolean|array true, false or array with group-account_id's
+	 * @return boolean true, false or array with group-account_id's
 	 */
 	static function not_enum_group_acls($data)
 	{

Indentation +1 added lines, -1 removed lines

@@ -153,7 +153,7 @@
 			'admin'  => false,
 			'default'=> 'org_name: n_family, n_given',
 		);
-    	$settings['link_title_cf'] = array(
+		$settings['link_title_cf'] = array(
 			'type'  => 'select',
 			'label' => 'Add a customfield to link title',
 			'name'  => 'link_title_cf',

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)
 	{

Indentation +28 added lines, -28 removed lines

@@ -29,8 +29,8 @@ 
 	private $bocontacts;
 
 	/**
-	* For figuring out if a contact has changed
-	*/
+	 * For figuring out if a contact has changed
+	 */
 	protected $tracking;
 
 	/**
@@ -377,39 +377,39 @@ 
 	}
 
 	/**
-        * Returns warnings that were encountered during importing
-        * Maximum of one warning message per record, but you can append if you need to
-        *
-        * @return Array (
-        *       record_# => warning message
-        *       )
-        */
-        public function get_warnings() {
+	 * Returns warnings that were encountered during importing
+	 * Maximum of one warning message per record, but you can append if you need to
+	 *
+	 * @return Array (
+	 *       record_# => warning message
+	 *       )
+	 */
+		public function get_warnings() {
 		return $this->warnings;
 	}
 
 	/**
-        * Returns errors that were encountered during importing
-        * Maximum of one error message per record, but you can append if you need to
-        *
-        * @return Array (
-        *       record_# => error message
-        *       )
-        */
-        public function get_errors() {
+	 * Returns errors that were encountered during importing
+	 * Maximum of one error message per record, but you can append if you need to
+	 *
+	 * @return Array (
+	 *       record_# => error message
+	 *       )
+	 */
+		public function get_errors() {
 		return $this->errors;
 	}
 
 	/**
-        * Returns a list of actions taken, and the number of records for that action.
-        * Actions are things like 'insert', 'update', 'delete', and may be different for each plugin.
-        *
-        * @return Array (
-        *       action => record count
-        * )
-        */
-        public function get_results() {
-                return $this->results;
-        }
+	 * Returns a list of actions taken, and the number of records for that action.
+	 * Actions are things like 'insert', 'update', 'delete', and may be different for each plugin.
+	 *
+	 * @return Array (
+	 *       action => record count
+	 * )
+	 */
+		public function get_results() {
+				return $this->results;
+		}
 } // end of iface_export_plugin
 ?>

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)

admin/inc/class.admin_statistics.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -291,7 +291,7 @@
 	 * Check if next submission is due, in which case we call submit and NOT return to the admin hook
 	 *
 	 * @param boolean $redirect should we redirect or return true
-	 * @return boolean true if statistic submission is due
+	 * @return boolean|null true if statistic submission is due
 	 */
 	public static function check($redirect=true)
 	{

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/Vfs/Filesystem/StreamWrapper.php

Doc Comments +3 added lines, -3 removed lines

@@ -271,7 +271,7 @@ 
 	 *
 	 * If you have cached data in your stream but not yet stored it into the underlying storage, you should do so now.
 	 *
-	 * @return booelan TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored.
+	 * @return boolean TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored.
 	 */
 	function stream_flush ( )
 	{
@@ -507,7 +507,7 @@ 
 	 *
 	 * @param string $url URL that was passed to opendir() and that this object is expected to explore.
 	 * @param int $options
-	 * @return booelan
+	 * @return boolean
 	 */
 	function dir_opendir ( $url, $options )
 	{
@@ -616,7 +616,7 @@ 
 	 * It should reset the output generated by dir_readdir(). i.e.:
 	 * The next call to dir_readdir() should return the first entry in the location returned by dir_opendir().
 	 *
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function dir_rewinddir ( )
 	{

Indentation +2 added lines, -2 removed lines

@@ -80,10 +80,10 @@
  	 * Important: PHP 5.0 introduced a bug that wasn't fixed until 5.1: the return value has to be the oposite!
  	 *
  	 * if(version_compare(PHP_VERSION,'5.0','>=') && version_compare(PHP_VERSION,'5.1','<'))
-  	 * {
+ 	 * {
  	 * 		$eof = !$eof;
  	 * }
-  	 *
+ 	 *
  	 * @return boolean true if the read/write position is at the end of the stream and no more data availible, false otherwise
  	 */
 	function stream_eof ( );

api/src/Vfs/Links/StreamWrapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -316,7 +316,7 @@
 	 *
 	 * @param string $url URL that was passed to opendir() and that this object is expected to explore.
 	 * @param $options
-	 * @return booelan
+	 * @return boolean
 	 */
 	function dir_opendir ( $url, $options )
 	{