EGroupware / egroupware

api/src/Vfs/StreamWrapperIface.php

Doc Comments +4 added lines, -3 removed lines

@@ -45,6 +45,7 @@ 
 	 * This method is called when the stream is closed, using fclose().
 	 *
 	 * You must release any resources that were locked or allocated by the stream.
+	 * @return boolean
 	 */
 	function stream_close ( );
 
@@ -57,7 +58,7 @@ 
 	 * You must also update the read/write position of the stream by the number of bytes that were successfully read.
 	 *
 	 * @param int $count
-	 * @return string/false up to count bytes read or false on EOF
+	 * @return string|false up to count bytes read or false on EOF
 	 */
 	function stream_read ( $count );
 
@@ -114,7 +115,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 ( );
 
@@ -188,7 +189,7 @@ 
 	 * This method is called immediately when your stream object is created for examining directory contents with opendir().
 	 *
 	 * @param string $path URL that was passed to opendir() and that this object is expected to explore.
-	 * @return booelan
+	 * @return boolean
 	 */
 	function dir_opendir ( $path, $options );
 

calendar/importexport/class.import_events_csv.inc.php

Doc Comments -1 removed lines

@@ -94,7 +94,6 @@
 	/**
 	 * imports entries according to given definition object.
 	 * @param resource $_stream
-	 * @param string $_charset
 	 * @param definition $_definition
 	 */
 	public function import( $_stream, definition $_definition ) {

calendar/inc/class.calendar_boupdate.inc.php

Doc Comments +11 added lines, -6 removed lines

@@ -519,6 +519,7 @@ 
 	 * @param array $new_event Event after the change
 	 * @param string $role we treat CHAIR like event owners
 	 * @param string $status of current user
+	 * @param integer $msg_type
 	 * @return boolean true = update requested, false otherwise
 	 */
 	public static function update_requested($userid, $part_prefs, &$msg_type, $old_event ,$new_event, $role, $status=null)
@@ -594,7 +595,7 @@ 
 	/**
 	 * Check calendar prefs, if a given user (integer account_id) or email (user or externals) should get notified
 	 *
-	 * @param int|string $user_or_email
+	 * @param string $user_or_email
 	 * @param string $ical_method ='REQUEST'
 	 * @param string $role ='REQ-PARTICIPANT'
 	 * @return boolean true if user requested to be notified, false if not
@@ -645,8 +646,7 @@ 
 	 * Get iCal/iMip method from internal nummeric msg-type plus optional notification message and verbose name
 	 *
 	 * @param int $msg_type see MSG_* defines
-	 * @param string& $action=null on return verbose name
-	 * @param string& $msg=null on return notification message
+	 * @param string& $action on return verbose name
 	 */
 	function msg_type2ical_method($msg_type, &$action=null, &$msg=null)
 	{
@@ -1011,6 +1011,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $added
+	 */
 	function get_update_message($event,$added)
 	{
 		$nul = null;
@@ -1300,8 +1303,8 @@ 
 	 *
 	 * @param int $right self::CAT_ACL_{ADD|STATUS}
 	 * @param int|array $event
-	 * @return boolean true if use has the right, false if not
-	 * @return boolean false=access denied because of cat acl, true access granted because of cat acl,
+	 * @return null|boolean true if use has the right, false if not
+	 * @return null|boolean false=access denied because of cat acl, true access granted because of cat acl,
 	 * 	null = cat has no acl
 	 */
 	function check_cat_acl($right,$event)
@@ -1386,6 +1389,8 @@ 
 	 * Check if current user has a given right on a category (if it's restricted!)
 	 *
 	 * @param int $cat_id
+	 * @param integer $right
+	 * @param integer $user
 	 * @return boolean false=access denied because of cat acl, true access granted because of cat acl,
 	 * 	null = cat has no acl
 	 */
@@ -1647,7 +1652,7 @@ 
 	 * @param string $action
 	 * @param array $event_arr
 	 * @param array $disinvited
-	 * @return array
+	 * @return string
 	 */
 	function _get_event_details($event,$action,&$event_arr,$disinvited=array())
 	{

calendar/inc/class.calendar_groupdav.inc.php

Doc Comments +10 added lines, -10 removed lines

@@ -315,7 +315,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)
@@ -620,7 +620,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)
 	{
@@ -793,7 +793,7 @@ 
 	 * Check if $user is a participant of given $event incl. group-invitations
 	 *
 	 * @param array $event
-	 * @param int|string $user
+	 * @param integer $user
 	 * @return boolean
 	 */
 	public static function isParticipant(array $event, $user)
@@ -810,7 +810,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)
 	{
@@ -1038,7 +1038,7 @@ 
 	 * @param array &$options
 	 * @param int $id
 	 * @param int $user =null account_id of owner, default null
-	 * @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 post(&$options,$id,$user=null)
 	{
@@ -1112,7 +1112,7 @@ 
 	 * @param string $charset of ical
 	 * @param int $user account_id of owner
 	 * @param array &$options
-	 * @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')
 	 */
 	protected function outbox_freebusy_request($ical, $charset, $user, array &$options)
 	{
@@ -1187,7 +1187,7 @@ 
 	 * @param string $path
 	 * @param array $options
 	 * @param int $user account_id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return string|null boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function free_busy_report($path,$options,$user)
 	{
@@ -1416,7 +1416,7 @@ 
 	/**
 	 * Query ctag for calendar
 	 *
-	 * @return string
+	 * @return integer
 	 */
 	public function getctag($path,$user)
 	{
@@ -1432,7 +1432,7 @@ 
 	 *
 	 * @param array|int $entry array with event or cal_id
 	 * @param string $schedule_tag =null on return schedule-tag
-	 * @return string|boolean string with etag or false
+	 * @return string string with etag or false
 	 */
 	function get_etag($entry, &$schedule_tag=null)
 	{
@@ -1449,7 +1449,7 @@ 
 	 *
 	 * @param int|array $entry id or array of new created entry
 	 * @param string $path
-	 * @param int|string $retval
+	 * @param string|boolean $retval
 	 * @param boolean $path_attr_is_name =true true: path_attr is ca(l|rd)dav_name, false: id (GroupDAV needs Location header)
 	 */
 	function put_response_headers($entry, $path, $retval, $path_attr_is_name=true)

calendar/inc/class.calendar_import_csv.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -74,7 +74,7 @@ 
 	 * @param importepport_iface_egw_record record The egw_record object being imported
 	 * @param importexport_iface_import_record import_csv Import object contains current state
 	 *
-	 * @return boolean success
+	 * @return null|boolean success
 	 */
 	public function import_record(\importexport_iface_egw_record &$record, &$import_csv)
 	{
@@ -254,7 +254,6 @@ 
 	 * perform the required action
 	 *
 	 * @param int $_action one of $this->actions
-	 * @param array $_data record data for the action
 	 * @return bool success or not
 	 */
 	protected function action ( $_action, importexport_iface_egw_record &$record, $record_num = 0 )
@@ -343,7 +342,7 @@ 
 	/**
 	 * Alter a row for preview to show multiple participants instead of Array
 	 *
-	 * @param egw_record $row_entry
+	 * @param importexport_iface_egw_record $row_entry
 	 */
 	protected function row_preview(importexport_iface_egw_record &$row_entry)
 	{

calendar/inc/class.calendar_merge.inc.php

Doc Comments -3 removed lines

@@ -113,8 +113,6 @@ 
 	 * @param array $ids array with contact id(s)
 	 * @param string &$err error-message on error
 	 * @param string $mimetype mimetype of complete document, eg. text/*, application/vnd.oasis.opendocument.text, application/rtf
-	 * @param array $fix=null regular expression => replacement pairs eg. to fix garbled placeholders
-	 * @param string $charset=null charset to override default set by mimetype or export charset
 	 * @return string|boolean merged document or false on error
 	 */
 	function merge_string($content,$ids,$err,$mimetype,$fix)
@@ -234,7 +232,6 @@ 
 	 * Return replacements for the calendar
 	 *
 	 * @param int|array $id event-id or array with id/recur_date, or array with event info
-	 * @param boolean $last_event_too=false also include information about the last event
 	 * @return array
 	 */
 	public function calendar_replacements($id,$prefix = '', &$content = '')

calendar/inc/class.calendar_timezones.inc.php

Doc Comments +1 added lines

@@ -204,6 +204,7 @@
 	 *
 	 * @param boolean &$updated=null on return true if update was neccessary, false if tz's were already up to date
 	 * @param string $file ='calendar/setup/timezones.sqlite' filename relative to EGW_SERVER_ROOT
+	 * @param boolean $updated
 	 * @return string message about update
 	 * @throws Api\Exception\WrongParameter if $file is not readable or wrong format/version
 	 * @throws Api\Exception\WrongUserinput if no PDO sqlite support

doc/fix_depricated.php

Doc Comments +2 added lines, -3 removed lines

@@ -23,7 +23,7 @@ 
  * Fix depricated stuff in a given file
  *
  * @param string $file filename
- * @param boolean $replace_file=false replace existing file if modifications are necessary, otherwise .php53 file is created
+ * @param boolean $replace_file replace existing file if modifications are necessary, otherwise .php53 file is created
  * @return boolean false on error
  */
 function fix_depricated($file,$replace_file=false)
@@ -146,7 +146,7 @@ 
  * Loop recursive through directory and call fix_depricated for each php file
  *
  * @param string $dir
- * @param boolean $replace_file=false replace existing file if modifications are necessary, otherwise .php53 file is created
+ * @param boolean $replace_file replace existing file if modifications are necessary, otherwise .php53 file is created
  * @return boolean false on error
  */
 function fix_depricated_recursive($dir,$replace_file=false)
@@ -174,7 +174,6 @@ 
 /**
  * Give usage
  *
- * @param string $error=null
  */
 function usage($error=null)
 {

doc/rpm-build/checkout-build-archives.php

Doc Comments +2 added lines, -1 removed lines

@@ -464,6 +464,7 @@ 
  *
  * @param string $name
  * @param string $value =null value to use, default $config[$name]
+ * @return string
  */
 function config_translate($name, $value=null)
 {
@@ -1194,7 +1195,7 @@ 
  * Runs given shell command, exists with error-code after echoing the output of the failed command (if not already running verbose)
  *
  * @param string $cmd
- * @param array& $output=null $output of command, only if !$verbose !!!
+ * @param array& $output $output of command, only if !$verbose !!!
  * @param int|array $no_bailout =null exit code(s) to NOT bail out
  * @return int exit code of $cmd
  */