EGroupware / egroupware

etemplate/thumbnail.php

Doc Comments +1 added lines

@@ -80,6 +80,7 @@
 
 /**
  * Returns the maximum width/height of a thumbnail
+ * @return integer|null
  */
 function get_maxsize()
 {

home/inc/class.home_ui.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -150,7 +150,7 @@
 	 * Get a list of the user's portlets, and their associated values & settings, for display
 	 *
 	 * Actual portlet content is provided by each portlet.
-	 * @param template etemplate so attributes can be set
+	 * @param template etemplate_new so attributes can be set
 	 */
 	protected function get_user_portlets(etemplate_new &$template)
 	{

importexport/inc/class.importexport_definitions_ui.inc.php

Doc Comments +3 added lines, -2 removed lines

@@ -76,7 +76,7 @@ 
 	/**
 	 * List defined {im|ex}ports
 	 *
-	 * @param array $content=null
+	 * @param array $content
 	 */
 	function index($content = null,$msg='')
 	{
@@ -303,7 +303,8 @@ 
 	 * @param int &$success number of succeded actions
 	 * @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 string/array $session_name 'index' or 'email', or array with session-data depending if we are in the main list or the popup
+	 * @param string $session_name 'index' or 'email', or array with session-data depending if we are in the main list or the popup
+	 * @param string $msg
 	 * @return boolean true if all actions succeded, false otherwise
 	 */
 	function action($action,$selected,$use_all,&$success,&$failed,&$action_msg,$session_name,&$msg)

infolog/inc/class.infolog_activesync.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -69,7 +69,7 @@ 
 	 *
 	 * Currently we only return an own infolog
 	 *
-	 * @param int $account=null account_id of addressbook or null to get array of all addressbooks
+	 * @param int $account account_id of addressbook or null to get array of all addressbooks
 	 * @return string|array folder name of array with int account_id => folder name pairs
 	 */
 	private function get_folders($account=null)
@@ -183,7 +183,7 @@ 
 	 * will work OK apart from that.
 	 *
 	 * @param string $id folder id
-	 * @param int $cutoffdate=null
+	 * @param int $cutoffdate
 	 * @return array
   	 */
 	function GetMessageList($id, $cutoffdate=NULL)
@@ -220,7 +220,7 @@ 
 	 * @param string $id
 	 * @param int $truncsize
 	 * @param int $bodypreference
-	 * @param bool $mimesupport
+	 * @param integer $mimesupport
 	 * @return $messageobject|boolean false on error
 	 */
 	public function GetMessage($folderid, $id, $truncsize, $bodypreference=false, $optionbodypreference=false, $mimesupport = 0)

infolog/inc/class.infolog_bo.inc.php

Doc Comments +1 added lines, -4 removed lines

@@ -1240,7 +1240,7 @@ 
 	 * Is called as hook to participate in the linking
 	 *
 	 * @param int|array $info int info_id or array with infolog entry
-	 * @return string|boolean string with the title, null if $info not found, false if no perms to view
+	 * @return string string with the title, null if $info not found, false if no perms to view
 	 */
 	function link_title($info)
 	{
@@ -1338,9 +1338,6 @@ 
 	/**
 	 * hook called be calendar to include events or todos in the cal-dayview
 	 *
-	 * @param int $args[year], $args[month], $args[day] date of the events
-	 * @param int $args[owner] owner of the events
-	 * @param string $args[location] calendar_include_{events|todos}
 	 * @return array of events (array with keys starttime, endtime, title, view, icon, content)
 	 */
 	function cal_to_include($args)

infolog/inc/class.infolog_groupdav.inc.php

Doc Comments +8 added lines, -13 removed lines

@@ -138,7 +138,7 @@ 
 	 * @param array &$options
 	 * @param array &$files
 	 * @param int $user account_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='')
 	{
@@ -217,7 +217,6 @@ 
 	 *
 	 * @param string $path
 	 * @param array $filter
-	 * @param array|boolean $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)
@@ -517,8 +516,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)
 	{
@@ -539,9 +537,8 @@ 
 	 *
 	 * @param array &$options
 	 * @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')
+	 * @param string $prefix user prefix from path (eg. /ralf from /ralf/addressbook)
+	 * @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)
 	{
@@ -609,7 +606,7 @@ 
 	 * Callback for infolog_ical::importVTODO to implement infolog-cat-action
 	 *
 	 * @param array $task
-	 * @param array $oldTask=null
+	 * @param array $oldTask
 	 * @return array modified task data
 	 */
 	public function cat_action(array $task, $oldTask=null)
@@ -675,7 +672,7 @@ 
 	 *
 	 * @param array &$options
 	 * @param int $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 delete(&$options,$id)
 	{
@@ -750,7 +747,7 @@ 
 	 * etag currently uses the modifcation time (info_datemodified), 1.9.002 adds etag column, but it's not yet used!
 	 *
 	 * @param array|int $info array with infolog entry or info_id
-	 * @return string|boolean string with etag or false
+	 * @return false|string string with etag or false
 	 */
 	function get_etag($info)
 	{
@@ -768,10 +765,8 @@ 
 	/**
 	 * Add extra properties for calendar collections
 	 *
-	 * @param array $props=array() regular props by the groupdav handler
 	 * @param string $displayname
-	 * @param string $base_uri=null base url of handler
-	 * @param int $user=null account_id of owner of collection
+	 * @param string $base_uri base url of handler
 	 * @return array
 	 */
 	public function extra_properties(array $props=array(), $displayname, $base_uri=null,$user=null)

infolog/inc/class.infolog_ical.inc.php

Doc Comments +4 added lines, -5 removed lines

@@ -112,7 +112,7 @@ 
 	 * @param string $_version ='2.0'
 	 * @param string $_method =null only set for iTip messages
 	 * @param string $charset ='UTF-8'
-	 * @return string|boolean string with vCal or false on error (eg. no permission to read the event)
+	 * @return false|string string with vCal or false on error (eg. no permission to read the event)
 	 */
 	function exportVCalendar(array $tasks, $_version='2.0', $_method=null, $charset='UTF-8')
 	{
@@ -137,7 +137,7 @@ 
 	 * @param string $charset ='UTF-8' encoding of the vcalendar, default UTF-8
 	 * @param Horde_Icalendar $vcal =null optional iCalendar object to add vtodo to
 	 *
-	 * @return string|boolean string with vCal or false on error (eg. no permission to read the event)
+	 * @return false|string string with vCal or false on error (eg. no permission to read the event)
 	 */
 	function exportVTODO($task, $_version='2.0',$_method='PUBLISH', $charset='UTF-8',Horde_Icalendar $vcal=null)
 	{
@@ -916,7 +916,7 @@ 
 	 * @param string $_type		content type (e.g. text/plain)
 	 * @param string $charset ='UTF-8' encoding of the vcalendar, default UTF-8
 	 *
-	 * @return string|boolean VNOTE representation of the infolog entry or false on error
+	 * @return false|string VNOTE representation of the infolog entry or false on error
 	 */
 	function exportVNOTE($_noteID, $_type, $charset='UTF-8')
 	{
@@ -1041,8 +1041,7 @@ 
 	 * Search a matching infolog entry for the VNOTE data
 	 *
 	 * @param string $_vcalData		VNOTE
-	 * @param int $contentID=null 	infolog_id (or null, if unkown)
-	 * @param boolean $relax=false 	if true, a weaker match algorithm is used
+	 * @param int $contentID 	infolog_id (or null, if unkown)
 	 * @param string $charset  The encoding charset for $text. Defaults to
      *                         utf-8 for new format, iso-8859-1 for old format.
 	 *

infolog/inc/class.infolog_sif.inc.php

Doc Comments +3 added lines, -6 removed lines

@@ -177,7 +177,6 @@ 
 	 *
 	 * @param string $sifData 	the SIF data
 	 * @param string $_sifType	type (note/task)
-	 * @param int $_id=-1		the infolog id
 	 * @return array infolog entry or false on error
 	 */
 	function siftoegw($sifData, $_sifType, $_id=-1)
@@ -407,10 +406,9 @@ 
 	/**
 	 * Search for SIF data a matching infolog entry
 	 *
-	 * @param string $sifData		the SIF data
+	 * @param string $_sifData		the SIF data
 	 * @param string $_sifType		type (note/task)
-	 * @param int $contentID=null 	infolog_id (or null, if unkown)
-	 * @param boolean $relax=false 	if true, a weaker match algorithm is used
+	 * @param int $contentID 	infolog_id (or null, if unkown)
 	 * @return infolog_id of a matching entry or false, if nothing was found
 	 */
 	function searchSIF($_sifData, $_sifType, $contentID=null, $relax=false)
@@ -427,9 +425,8 @@ 
 	/**
 	 * Add SIF data entry
 	 *
-	 * @param string $sifData		the SIF data
+	 * @param string $_sifData		the SIF data
 	 * @param string $_sifType		type (note/task)
-	 * @param boolean $merge=false	reserved for future use
 	 * @return infolog_id of the new entry or false, for errors
 	 */
 	function addSIF($_sifData, $_id, $_sifType, $merge=false)

infolog/inc/class.infolog_so.inc.php

Doc Comments +7 added lines, -22 removed lines

@@ -64,7 +64,6 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param array $grants=array()
 	 * @return soinfolog
 	 */
 	function __construct( $grants=array() )
@@ -102,9 +101,9 @@ 
 	 *
 	 * @param array|int $info data or info_id of InfoLog entry
 	 * @param int $required_rights EGW_ACL_xyz anded together
-	 * @param boolean $implicit_edit=false responsible has only implicit read and add rigths, unless this is set to true
-	 * @param array $grants=null grants to use, default (null) $this->grants
-	 * @param int $user=null user to check, default (null) $this->user
+	 * @param boolean $implicit_edit responsible has only implicit read and add rigths, unless this is set to true
+	 * @param array $grants grants to use, default (null) $this->grants
+	 * @param integer $user
 	 * @return boolean True if access is granted else False
 	 */
 	function check_access( $info,$required_rights,$implicit_edit=false,array $grants=null,$user=null )
@@ -274,7 +273,7 @@ 
 	 * generate sql to filter based on the status of the log-entry
 	 *
 	 * @param string $filter done = done or billed, open = not (done, billed, cancelled or deleted), offer = offer
-	 * @param boolean $prefix_and=true if true prefix the fileter with ' AND '
+	 * @param boolean $prefix_and if true prefix the fileter with ' AND '
 	 * @return string the necesary sql
 	 */
 	function statusFilter($filter = '',$prefix_and=true)
@@ -370,7 +369,7 @@ 
 	 * some cacheing is done to prevent multiple reads of the same entry
 	 *
 	 * @param array $where where clause for entry to read
-	 * @return array|boolean the entry as array or False on error (eg. entry not found)
+	 * @return boolean the entry as array or False on error (eg. entry not found)
 	 */
 	function read(array $where)		// did _not_ ensure ACL
 	{
@@ -474,8 +473,6 @@ 
 	 * changes or deletes entries with a spezified owner (for hook_delete_account)
 	 *
 	 * @param array $args hook arguments
-	 * @param int $args['account_id'] account to delete
-	 * @param int $args['new_owner']=0 new owner
 	 */
 	function change_delete_owner(array $args)  // new_owner=0 means delete
 	{
@@ -508,8 +505,8 @@ 
 	 * writes the given $values to InfoLog, a new entry gets created if info_id is not set or 0
 	 *
 	 * @param array $values with the data of the log-entry
-	 * @param int $check_modified=0 old modification date to check before update (include in WHERE)
-	 * @param string $purge_cfs=null null=dont, 'ical'=only iCal X-properties (cfs name starting with "#"), 'all'=all cfs
+	 * @param int $check_modified old modification date to check before update (include in WHERE)
+	 * @param string $purge_cfs null=dont, 'ical'=only iCal X-properties (cfs name starting with "#"), 'all'=all cfs
 	 * @return int|boolean info_id, false on error or 0 if the entry has been updated in the meantime
 	 */
 	function write($values, $check_modified=0, $purge_cfs=null)  // did _not_ ensure ACL
@@ -662,19 +659,7 @@ 
 	/**
 	 * searches InfoLog for a certain pattern in $query
 	 *
-	 * @param string $query[order] column-name to sort after
-	 * @param string $query[sort] sort-order DESC or ASC
-	 * @param string $query[filter] string with combination of acl-, date- and status-filters, eg. 'own-open-today' or ''
-	 * @param int $query[cat_id] category to use or 0 or unset
-	 * @param string $query[search] pattern to search, search is done in info_from, info_subject and info_des
-	 * @param string $query[action] / $query[action_id] if only entries linked to a specified app/entry show be used
 	 * @param int &$query[start], &$query[total] nextmatch-parameters will be used and set if query returns less entries
-	 * @param array $query[col_filter] array with column-name - data pairs, data == '' means no filter (!)
-	 * @param boolean $query[subs] return subs or not, if unset the user preference is used
-	 * @param int $query[num_rows] number of rows to return if $query[start] is set, default is to use the value from the general prefs
-	 * @param string|array $query[cols]=null what to query, if set the recordset / iterator get's returned
-	 * @param string $query[append]=null get's appended to sql query, eg. for GROUP BY
-	 * @param boolean $query['custom_fields']=false query custom-fields too, default not
 	 * @return array|iterator with id's as key of the matching log-entries or recordset/iterator if cols is set
 	 */
 	function search(&$query)