EGroupware / egroupware

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

Doc Comments +3 added lines

@@ -135,6 +135,9 @@
 		return $until_year ? $years : $years[$year];
 	}
 
+	/**
+	 * @param string $url
+	 */
 	protected static function is_url($url)
 	{
 		return $url[0] == '/' || strpos($url, '://') !== false;

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

calendar/inc/class.calendar_uiforms.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -1077,7 +1077,7 @@ 
 	 *	date instead of today
 	 * @param boolean $no_notifications Toggle notifications to participants
 	 *
-	 * @return false or error message
+	 * @return string|false or error message
 	 */
 	function _break_recurring(&$event, $old_event, $as_of_date = null, $no_notifications = true)
 	{
@@ -2173,7 +2173,7 @@ 
 	 * Freetime search
 	 *
 	 * As the function is called in a popup via javascript, parametes get initialy transfered via the url
-	 * @param array $content=null array with parameters or false (default) to use the get-params
+	 * @param array $content array with parameters or false (default) to use the get-params
 	 * @param string start[str] start-date
 	 * @param string start[hour] start-hour
 	 * @param string start[min] start-minutes
@@ -2417,7 +2417,7 @@ 
 	/**
      * Export events as vCalendar version 2.0 files (iCal)
      *
-     * @param int|array $content numeric cal_id or submitted content from etempalte::exec
+     * @param integer $content numeric cal_id or submitted content from etempalte::exec
      * @param boolean $return_error should an error-msg be returned or a regular page with it generated (default)
      * @return string error-msg if $return_error
      */

calendar/inc/class.calendar_uilist.inc.php

Doc Comments +3 added lines, -2 removed lines

@@ -539,8 +539,9 @@
 	 * @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 events 'deleted'
-	 * @param string/array $session_name 'calendar_list'
-	 * @return boolean true if all actions succeded, false otherwise
+	 * @param string $session_name 'calendar_list'
+	 * @param null|string $msg
+	 * @return null|boolean true if all actions succeded, false otherwise
 	 */
 	function action($action,$checked,$use_all,&$success,&$failed,&$action_msg,$session_name,&$msg,$skip_notification=false)
 	{

calendar/inc/class.calendar_uiviews.inc.php

Doc Comments +8 added lines, -6 removed lines

@@ -412,7 +412,7 @@ 
 	/**
 	 * Displays the planner view
 	 *
-	 * @param boolean|Etemplate $home = false if etemplate return content suitable for home-page
+	 * @param null|Etemplate $home = false if etemplate return content suitable for home-page
 	 */
 	function &planner($content = array(), $home=false)
 	{
@@ -497,7 +497,7 @@ 
 	 * Used for home app
 	 *
 	 * @param int $weeks = 0 number of weeks to show, if 0 (default) all weeks of one month are shown
-	 * @param boolean|etemplate2 $home = false if not false return content suitable for home-page
+	 * @param null|Etemplate $home = false if not false return content suitable for home-page
 	 */
 	function &month($weeks=0,$home=false)
 	{
@@ -580,6 +580,8 @@ 
 	 * @param int &$first timestamp 0h of first day of week containing the first of the current month
 	 * @param int &$last timestamp 23:59:59 of last day of week containg the last day of the current month
 	 * @param int $day = 1 should the alignment be based on the 1. of the month or an other date, eg. the 15.
+	 * @param integer $first
+	 * @param integer $last
 	 */
 	function _week_align_month(&$first,&$last,$day=1)
 	{
@@ -604,7 +606,7 @@ 
 	 * Displays the weekview, with 5 or 7 days
 	 *
 	 * @param int $days = 0 number of days to show, if 0 (default) the value from the URL or the prefs is used
-	 * @param boolean|etemplate2 $home = false if not false return content suitable for home-page
+	 * @param null|Etemplate $home = false if not false return content suitable for home-page
 	 */
 	function week($days=0,$home=false)
 	{
@@ -740,7 +742,7 @@ 
 	/**
 	 * Query the open ToDo's via a hook from InfoLog or any other 'calendar_include_todos' provider
 	 *
-	 * @param array/string $todo_label label for the todo-box or array with 2 values: the label and a boolean show_all
+	 * @param string $todo_label label for the todo-box or array with 2 values: the label and a boolean show_all
 	 *	On return $todo_label contains the label for the todo-box
 	 * @return string/boolean Api\Html with a table of open todo's or false if no hook availible
 	 */
@@ -824,7 +826,7 @@ 
 	 * - 'edit_popup' => '400x300' (optional)
 	 *
 	 * @param string $app
-	 * @param int|string $id
+	 * @param string $id
 	 * @return string
 	 */
 	public static function integration_get_popup($app,$id)
@@ -864,7 +866,7 @@ 
 	 * Icons specified in $events['icons'] are always displayed!
 	 *
 	 * @param string $app
-	 * @param int|string $id
+	 * @param string $id
 	 * @param array $event
 	 * @return array
 	 */

calendar/setup/tables_update.inc.php

Doc Comments +5 added lines, -1 removed lines

@@ -11,6 +11,10 @@ 
 
 use EGroupware\Api;
 
+/**
+ * @param string $table
+ * @param string $field
+ */
 function calendar_v0_9_2to0_9_3update_owner($table, $field)
 {
 	$GLOBALS['egw_setup']->oProc->query("select distinct($field) from $table");
@@ -2306,7 +2310,7 @@ 
  *
  * Also fix recurring events containing a reference to an other master, created when an exception is made a recurring event.
  *
- * @return type
+ * @return string
  */
 function calendar_upgrade14_1()
 {

doc/fix_api.php

Doc Comments +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
  *
  * @param string $file filename
  * @param boolean $dry_run =false true: only echo fixed file, not fix it
- * @return boolean false on error
+ * @return boolean|null false on error
  */
 function fix_api($file, $dry_run=false)
 {