EGroupware / egroupware

infolog/inc/class.infolog_ui.inc.php

Doc Comments +9 added lines, -12 removed lines

@@ -295,6 +295,8 @@ 
 	 * @param array &$query
 	 * @param array &$rows
 	 * @param array &$readonlys
+	 * @param type|null $rows
+	 * @param type|null $readonlys
 	 * @return int
 	 */
 	function get_rows(&$query,&$rows,&$readonlys)
@@ -575,7 +577,6 @@ 
 	 * Hook for timesheet to set some extra data and links
 	 *
 	 * @param array $data
-	 * @param int $data[id] info_id
 	 * @return array with key => value pairs to set in new timesheet and link_app/link_id arrays
 	 */
 	function timesheet_set($data)
@@ -601,7 +602,6 @@ 
 	 * Hook for calendar to set some extra data and links
 	 *
 	 * @param array $data event-array preset by calendar plus
-	 * @param int $data[entry_id] info_id
 	 * @return array with key => value pairs to set in new event and link_app/link_id arrays
 	 */
 	function calendar_set($data)
@@ -691,9 +691,6 @@ 
 	 * Since the hook has no idea about infolog or preferences, we add the user's
 	 * current sorting for infolog here so they're in the expected order
 	 *
-	 * @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)
 	 */
 	public function cal_to_include($args)
@@ -711,11 +708,11 @@ 
 	/**
 	 * Shows the infolog list
 	 *
-	 * @param array/string $values etemplate content or 'reset_action_view' if called by index.php to reset an action-view
+	 * @param integer $values etemplate content or 'reset_action_view' if called by index.php to reset an action-view
 	 * @param string $action if set only entries liked to that $action:$action_id are shown
 	 * @param string $action_id if set only entries liked to that $action:$action_id are shown
-	 * @param mixed $called_as is how we got called, for a hook eg. the call-params of that page containing the hook
-	 * @param boolean $e$extra_app_header * @param boolean $return_html=false
+	 * @param integer $called_as is how we got called, for a hook eg. the call-params of that page containing the hook
+	 * @param boolean $extra_app_header * @param boolean $return_html
 	 * @param string $own_referer='' this is our own referer
 	 * @param string $action_title='' app_header for the action, if '' we try the link-title
 	 */
@@ -1327,7 +1324,7 @@ 
 	 * @param array $query get_rows parameter
 	 * @param string &$msg on return user feedback
 	 * @param boolean $skip_notifications true to NOT notify users about changes
-	 * @return boolean true if all actions succeded, false otherwise
+	 * @return boolean|null true if all actions succeded, false otherwise
 	 */
 	function action($_action, $checked, $use_all, &$success, &$failed, &$action_msg,
 		array $query, &$msg, $skip_notifications = false)
@@ -1572,9 +1569,9 @@ 
 	/**
 	 * Closes an infolog
 	 *
-	 * @param int|array $values=0 info_id (default _GET[info_id])
+	 * @param int|array $values info_id (default _GET[info_id])
 	 * @param string $_referer=''
-	 * @param boolean $closesingle=false
+	 * @param boolean $closesingle
 	 */
 	function close($values=0,$_referer='',$closesingle=false,$skip_notification = false)
 	{
@@ -1622,7 +1619,7 @@ 
 	/**
 	 * Deletes an InfoLog entry
 	 *
-	 * @param array|int $values info_id (default _GET[info_id])
+	 * @param integer $values info_id (default _GET[info_id])
 	 * @param string $_referer
 	 * @param string $called_by
 	 * @param boolean $skip_notification Do not send notification of deletion

calendar/inc/class.calendar_holidays.inc.php

Doc Comments +4 added lines, -1 removed lines

@@ -42,7 +42,7 @@ 
 	 *
 	 * @param string $country 2-digit iso country code or URL
 	 * @param int $year =null default current year
-	 * @return array of Ymd => array of array with values for keys 'occurence','month','day','name', (commented out) 'title'
+	 * @return integer of Ymd => array of array with values for keys 'occurence','month','day','name', (commented out) 'title'
 	 */
 	public static function read($country, $year=null)
 	{
@@ -140,6 +140,9 @@ 
 		return $until_year ? $years : $years[$year];
 	}
 
+	/**
+	 * @param string $url
+	 */
 	protected static function is_url($url)
 	{
 		return $url[0] == '/' || strpos($url, '://') !== false;

api/src/Storage/Customfields.php

Doc Comments +4 added lines, -1 removed lines

@@ -159,7 +159,7 @@ 
 	 * @param string $app
 	 * @param boolean $all_private_too =false should all the private fields be returned too, default no
 	 * @param string $only_type2 =null if given only return fields of type2 == $only_type2
-	 * @return boolen true: if there is a custom field useing html, false if not
+	 * @return boolean true: if there is a custom field useing html, false if not
 	 */
 	public static function use_html($app, $all_private_too=false, $only_type2=null)
 	{
@@ -585,6 +585,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $entry_id
+	 */
 	protected static function handle_file($entry_id, $field, $value)
 	{
 		$path = Api\Etemplate\Widget\Vfs::get_vfs_path($field['app'].":$entry_id:".$field['label']);

mail/inc/class.mail_ui.inc.php

Doc Comments +14 added lines, -10 removed lines

@@ -1728,7 +1728,7 @@ 
 	 * function splitRowID - split the rowID into its parts
 	 *
 	 * @param string $_rowID string - a colon separated string in the form accountID:profileID:folder:message_uid
-	 * @return array populated named result array (accountID,profileID,folder,msgUID)
+	 * @return string populated named result array (accountID,profileID,folder,msgUID)
 	 */
 	static function splitRowID($_rowID)
 	{
@@ -1814,9 +1814,9 @@ 
 	 * function header2gridelements - to populate the grid elements with the collected Data
 	 *
 	 * @param array $_headers headerdata to process
-	 * @param array $cols cols to populate
+	 * @param string[] $cols cols to populate
 	 * @param array $_folderName to ensure the uniqueness of the uid over all folders
-	 * @param array $_folderType used to determine if we need to populate from/to
+	 * @param integer $_folderType used to determine if we need to populate from/to
 	 * @return array populated result array
 	 */
 	public function header2gridelements($_headers, $cols, $_folderName, $_folderType=0)
@@ -3060,6 +3060,9 @@ 
 		return $GLOBALS['egw']->framework->header();
 	}
 
+	/**
+	 * @param string $body
+	 */
 	function showBody(&$body, $print=true,$fullPageTags=true)
 	{
 		$BeginBody = '<div class="mailDisplayBody">
@@ -3302,9 +3305,9 @@ 
 	 * Replace CID with proper type of content understandable by browser
 	 *
 	 * @param type $_body content of message
-	 * @param type $_mailbox mail box
-	 * @param type $_uid uid
-	 * @param type $_partID part id
+	 * @param string $_mailbox mail box
+	 * @param string $_uid uid
+	 * @param string $_partID part id
 	 * @param type $_type = 'src' type of inline image that needs to be resolved and replaced
 	 *	- types: {plain|src|url|background}
 	 * @return string returns body content including all CID replacements
@@ -3490,7 +3493,7 @@ 
 	 * @param string $_folder (passed by reference) will set the folder used. must be set with a folder, but will hold modifications if
 	 *					folder is modified
 	 * @param string $importID ID for the imported message, used by attachments to identify them unambiguously
-	 * @return mixed $messageUID or exception
+	 * @return string $messageUID or exception
 	 */
 	function importMessageToFolder($_formData,&$_folder,$importID='')
 	{
@@ -3651,7 +3654,7 @@ 
 	 *
 	 * @param string _messageID UID
 	 *
-	 * @return xajax response
+	 * @return string|null response
 	 */
 	function loadEmailBody($_messageID=null,$_partID=null,$_htmloptions=null)
 	{
@@ -4206,7 +4209,7 @@ 
 	 * ajax_deleteFolder - its called via json, so the function must start with ajax (or the class-name must contain ajax)
 	 * @param string $_folderName folder to delete
 	 * @param boolean $_return = false wheter return the success value (true) or send response to client (false)
-	 * @return nothing
+	 * @return boolean|null
 	 */
 	function ajax_deleteFolder($_folderName, $_return = false)
 	{
@@ -4977,8 +4980,9 @@ 
 	 * @param string _move2ArchiveMarker marker to indicate if a move 2 archive was triggered
 	 * @param boolean _return if true the function will return the result instead of
 	 * responding to client
+	 * @param string $_folderName
 	 *
-	 * @return xajax response
+	 * @return string|null response
 	 */
 	function ajax_copyMessages($_folderName, $_messageList, $_copyOrMove='copy', $_move2ArchiveMarker='_', $_return = false)
 	{