EGroupware / egroupware

admin/inc/class.admin_cmd_delete_account.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -19,8 +19,8 @@ 
 	 * Constructor
 	 *
 	 * @param string/int/array $account account name or id, or array with all parameters
-	 * @param string $new_user=null if specified, account to transfer the data to (users only)
-	 * @param string $is_user=true type of the account: true=user, false=group
+	 * @param string $new_user if specified, account to transfer the data to (users only)
+	 * @param string $is_user type of the account: true=user, false=group
 	 */
 	function __construct($account,$new_user=null,$is_user=true)
 	{
@@ -38,7 +38,7 @@ 
 	/**
 	 * delete an account (user or group)
 	 *
-	 * @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 egw_exception_no_admin
 	 * @throws egw_exception_wrong_userinput(lang("Unknown account: %1 !!!",$this->account),15);

admin/inc/class.admin_cmd_edit_group.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -19,7 +19,6 @@ 
 	 * Constructor
 	 *
 	 * @param string/int/array $account account name or id (!$account to add a new account), or array with all parameters
-	 * @param array $set=null array with all data to change
 	 */
 	function __construct($account,$set=null)
 	{
@@ -36,7 +35,7 @@ 
 	/**
 	 * change the password of a given user
 	 *
-	 * @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 egw_exception_no_admin
 	 * @throws egw_exception_wrong_userinput(lang("Unknown account: %1 !!!",$this->account),15);

admin/inc/class.admin_cmds.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
 	/**
 	 * Showing the command history and the scheduled commands
 	 *
-	 * @param array $content=null
+	 * @param array $content
 	 */
 	static function index(array $content=null)
 	{
@@ -108,7 +108,7 @@ 
 	/**
 	 * Showing remote administration instances
 	 *
-	 * @param array $content=null
+	 * @param array $content
 	 */
 	static function remotes(array $content=null)
 	{

admin/inc/class.admin_customtranslation.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -127,8 +127,7 @@
 	/**
 	 * Show files shared
 	 *
-	 * @param array $content=null
-	 * @param string $msg=''
+	 * @param array $content
 	 */
 	public function index(array $content=null)
 	{

admin/inc/class.customfields.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -614,7 +614,7 @@ 
 	 * Validate and create a new content type
 	 *
 	 * @param array $content
-	 * @return string|boolean New type ID, or false for error
+	 * @return false|string New type ID, or false for error
 	 */
 	function create_content_type(&$content)
 	{
@@ -671,7 +671,7 @@ 
 	*
 	* @deprecated use egw_customfields::get() direct, no need to instanciate this UI class
 	* @author Cornelius Weiss
-	* @param boolean $all_private_too=false should all the private fields be returned too
+	* @param boolean $all_private_too should all the private fields be returned too
 	* @return array with customfields
 	*/
 	function get_customfields($all_private_too=false)

api/src/Vfs.php

Doc Comments +5 added lines, -5 removed lines

@@ -165,7 +165,7 @@ 
 	 * dir working on just the eGW VFS: returns directory object
 	 *
 	 * @param string $path filename with absolute path in the eGW VFS
-	 * @return Directory
+	 * @return \Directory
 	 */
 	static function dir($path)
 	{
@@ -1313,7 +1313,7 @@ 
 	 * Also works around PHP under Windows returning dirname('/something') === '\\', which is NOT understood by EGroupware's VFS!
 	 *
 	 * @param string $_url path or url
-	 * @return string|boolean parent or false if there's none ($path == '/')
+	 * @return false|string parent or false if there's none ($path == '/')
 	 */
 	static function dirname($_url)
 	{
@@ -1431,7 +1431,7 @@ 
 	 * @param array $_files List of files to include in the zip
 	 * @param string $name optional Zip file name.  If not provided, it will be determined automatically from the files
 	 *
-	 * @return undefined
+	 * @return string|null
 	 */
 	public static function download_zip(Array $_files, $name = false)
 	{
@@ -1741,7 +1741,7 @@ 
 	 * checkLock() helper
 	 *
 	 * @param  string resource path to check for locks
-	 * @return array|boolean false if there's no lock, else array with lock info
+	 * @return string false if there's no lock, else array with lock info
 	 */
 	static function checkLock($path)
 	{
@@ -1957,7 +1957,7 @@ 
 	/**
 	 * Copies the files given in $src to $dst.
 	 *
-	 * @param array $src contains the source file
+	 * @param string[] $src contains the source file
 	 * @param string $dst is the destination directory
 	 * @param int& $errs =null on return number of errors happened
 	 * @param array& $copied =null on return files copied

api/src/Vfs/Sqlfs/StreamWrapper.php

Doc Comments +8 added lines, -4 removed lines

@@ -515,7 +515,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 ( )
 	{
@@ -556,6 +556,7 @@ 
 	 * In order for the appropriate error message to be returned, do not define this method if your wrapper does not support unlinking!
 	 *
 	 * @param string $url
+	 * @param integer $parent_stat
 	 * @return boolean TRUE on success or FALSE on failure
 	 */
 	static function unlink ( $url, $parent_stat=null )
@@ -684,6 +685,8 @@ 
 
 	/**
 	 * due to problems with recursive directory creation, we have our own here
+	 * @param false|string $pathname
+	 * @param integer $mode
 	 */
 	protected static function mkdir_recursive($pathname, $mode, $depth=0)
 	{
@@ -1014,7 +1017,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 )
 	{
@@ -1717,7 +1720,7 @@ 
 	/**
 	 * Just a little abstration 'til I know how to organise stuff like that with PDO
 	 *
-	 * @param mixed $time
+	 * @param integer $time
 	 * @return string Y-m-d H:i:s
 	 */
 	static protected function _pdo_timestamp($time)
@@ -1802,6 +1805,7 @@ 
 	 * Replace the password of an url with '...' for error messages
 	 *
 	 * @param string &$url
+	 * @param string $url
 	 */
 	static protected function _remove_password(&$url)
 	{
@@ -1817,7 +1821,7 @@ 
 	/**
 	 * Get storage mode from url (get parameter 'storage', eg. ?storage=db)
 	 *
-	 * @param string|array $url complete url or array of url-parts from parse_url
+	 * @param string $url complete url or array of url-parts from parse_url
 	 * @return int self::STORE2FS or self::STORE2DB
 	 */
 	static function url2operation($url)

calendar/inc/class.calendar_activesync.inc.php

Doc Comments +10 added lines, -11 removed lines

@@ -171,8 +171,8 @@ 
 	 * will work OK apart from that.
 	 *
 	 * @param string $id folder id
-	 * @param int $cutoffdate=null
-	 * @param array $not_uids=null uids NOT to return for meeting requests
+	 * @param int $cutoffdate
+	 * @param array $not_uids uids NOT to return for meeting requests
 	 * @return array
   	 */
 	function GetMessageList($id, $cutoffdate=NULL, array $not_uids=null)
@@ -223,7 +223,7 @@ 
 	 * List all meeting requests / invitations of user NOT having a UID in $not_uids (already received by email)
 	 *
 	 * @param array $not_uids
-	 * @param int $cutoffdate=null
+	 * @param int $cutoffdate
 	 * @return array
 	 */
 	function GetMeetingRequests(array $not_uids, $cutoffdate=NULL)
@@ -266,7 +266,7 @@ 
 	 * @param int $truncsize
 	 * @param int $bodypreference
 	 * @param $optionbodypreference
-	 * @param bool $mimesupport
+	 * @param integer $mimesupport
 	 * @return SyncMail
 	 */
 	function GetMeetingRequest($id, $truncsize, $bodypreference=false, $optionbodypreference=false, $mimesupport = 0)
@@ -607,7 +607,6 @@ 
 	 *
 	 * @param SyncAppointment $message
 	 * @param int $account
-	 * @param array $event=array()
 	 * @return array
 	 */
 	private function message2event(SyncAppointment $message, $account, $event=array())
@@ -855,7 +854,7 @@ 
 	 * @param string $displayname => new folder name (to be created, or to be renamed to)
 	 * @param string $type folder type, ignored in IMAP
 	 *
-	 * @return array|boolean stat array or false on error
+	 * @return boolean stat array or false on error
 	 */
 	public function ChangeFolder($id, $oldid, $displayname, $type)
 	{
@@ -870,7 +869,7 @@ 
 	 * @param string $id of the folder to delete
 	 *
 	 * @return
-	 * @TODO check what is to be returned
+	 boolean @TODO check what is to be returned
 	 */
 	public function DeleteFolder($parentid, $id)
 	{
@@ -958,9 +957,9 @@ 
 	 * @param string $folderid
 	 * @param string|array $id cal_id or event array (used internally)
 	 * @param int $truncsize
-	 * @param int|bool $bodypreference=false
+	 * @param int|bool $bodypreference
 	 * @param $optionbodypreference=false
-	 * @param int $mimesupport=0
+	 * @param int $mimesupport
 	 * @return SyncAppointment|boolean false on error
 	 */
 	public function GetMessage($folderid, $id, $truncsize, $bodypreference=false, $optionbodypreference=false, $mimesupport = 0)
@@ -1303,7 +1302,6 @@ 
 	 * matching timezones for incomming timezone data. iPhone seems not to care on receiving about the above.
 	 *
 	 * @param string|DateTimeZone $tz timezone, timezone name (eg. "Europe/Berlin") or ical with VTIMEZONE
-	 * @param int|string|DateTime $ts=null time for which active sync timezone data is requested, default current time
 	 * @return array with values for keys:
 	 * - "bias": timezone offset from UTC in minutes for NO DST
 	 * - "dstendmonth", "dstendday", "dstendweek", "dstendhour", "dstendminute", "dstendsecond", "dstendmillis"
@@ -1468,7 +1466,7 @@ 
 	 * )
 	 *
 	 * @param string|array $ical lines of ical file
-	 * @param string $component=null
+	 * @param string $component
 	 * @return array with parsed ical components
 	 */
 	static public function ical2array(&$ical,$component=null)
@@ -1542,6 +1540,7 @@ 
 	 * Unpack timezone info from Sync
 	 *
 	 * copied from backend/ics.php
+	 * @param string $data
 	 */
 	static public function _getTZFromSyncBlob($data)
 	{

calendar/inc/class.calendar_bo.inc.php

Doc Comments +7 added lines, -13 removed lines

@@ -638,8 +638,8 @@ 
 	 * or an ExecMethod callback with parameters $id,$event
 	 *
 	 * @param string $app
-	 * @param int|string $id
-	 * @return string
+	 * @param string $id
+	 * @return boolean
 	 */
 	static function integration_get_private($app,$id,$event)
 	{
@@ -768,7 +768,7 @@ 
 	 * This methods operates in usertime, while $this->config['horizont'] is in servertime!
 	 *
 	 * @param array $event
-	 * @param mixed $start =0 minimum start-time for new recurrences or !$start = since the start of the event
+	 * @param integer $start =0 minimum start-time for new recurrences or !$start = since the start of the event
 	 */
 	function set_recurrences($event,$start=0)
 	{
@@ -989,10 +989,9 @@ 
 	 * Recurrences get calculated by rrule iterator implemented in calendar_rrule class.
 	 *
 	 * @param array $event repeating event whos repetions should be inserted
-	 * @param mixed $start start-date
+	 * @param mixed $_start start-date
 	 * @param mixed $end end-date
 	 * @param array $events where the repetions get inserted
-	 * @param array $recur_exceptions with date (in Ymd) as key (and True as values), seems not to be used anymore
 	 */
 	function insert_all_recurrences($event,$_start,$end,&$events)
 	{
@@ -1146,7 +1145,7 @@ 
 	 *	even if you have no general read-grant from that user.
 	 *
 	 * @param int $needed necessary ACL right: EGW_ACL_{READ|EDIT|DELETE}
-	 * @param mixed $event event as array or the event-id or 0 for a general check
+	 * @param integer $event event as array or the event-id or 0 for a general check
 	 * @param int $other uid to check (if event==0) or 0 to check against $this->user
 	 * @param string $date_format ='ts' date-format used for reading: 'ts'=timestamp, 'array'=array, 'string'=iso8601 string for xmlrpc
 	 * @param mixed $date_to_read =null date used for reading, internal param for the caching
@@ -1319,8 +1318,6 @@ 
 	 * @param string $msg message with parameters/variables like lang(), eg. '%1'
 	 * @param boolean $backtrace =True include a function-backtrace, default True=On
 	 *	should only be set to False=Off, if your code ensures a call with backtrace=On was made before !!!
-	 * @param mixed $param a variable number of parameters, to be inserted in $msg
-	 *	arrays get serialized with print_r() !
 	 */
 	static function debug_message($msg,$backtrace=True)
 	{
@@ -1384,7 +1381,7 @@ 
 	 * Formats one or two dates (range) as long date (full monthname), optionaly with a time
 	 *
 	 * @param mixed $_first first date
-	 * @param mixed $last =0 last date if != 0 (default)
+	 * @param integer $last =0 last date if != 0 (default)
 	 * @param boolean $display_time =false should a time be displayed too
 	 * @param boolean $display_day =false should a day-name prefix the date, eg. monday June 20, 2006
 	 * @return string with formated date
@@ -1859,7 +1856,6 @@ 
 	 *
 	 * Is called as hook to participate in the linking
 	 *
-	 * @param int|array $entry int cal_id or array with event
 	 * @param string|boolean string with title, null if not found or false if not read perms
 	 */
 	function link_title($event)
@@ -2053,7 +2049,7 @@ 
 	 *
 	 * @param array|int|string $entry array with event or cal_id, or cal_id:recur_date for virtual exceptions
 	 * @param string &$schedule_tag=null on return schedule-tag (egw_cal.cal_id:egw_cal.cal_etag, no participant modifications!)
-	 * @return string|boolean string with etag or false
+	 * @return string string with etag or false
 	 */
 	function get_etag($entry, &$schedule_tag=null)
 	{
@@ -2093,7 +2089,6 @@ 
 	 * Hook for infolog  to set some extra data and links
 	 *
 	 * @param array $data event-array preset by infolog plus
-	 * @param int $data[id] cal_id
 	 * @return array with key => value pairs to set in new event and link_app/link_id arrays
 	 */
 	function infolog_set($data)
@@ -2145,7 +2140,6 @@ 
 	 * Hook for timesheet to set some extra data and links
 	 *
 	 * @param array $data
-	 * @param int $data[id] cal_id:recurrence
 	 * @return array with key => value pairs to set in new timesheet and link_app/link_id arrays
 	 */
 	function timesheet_set($data)