From c281e0354788cd283ac225753cdec165b028be51 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sat, 16 Jun 2007 23:59:15 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237863 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/icap/functions/icap-close.xml | 36 ++-- .../icap/functions/icap-create-calendar.xml | 38 ++-- .../icap/functions/icap-delete-calendar.xml | 38 ++-- .../icap/functions/icap-delete-event.xml | 44 ++-- reference/icap/functions/icap-fetch-event.xml | 196 +++++++++--------- reference/icap/functions/icap-list-alarms.xml | 123 ++++++----- reference/icap/functions/icap-list-events.xml | 124 ++++++----- reference/icap/functions/icap-open.xml | 50 ++--- .../icap/functions/icap-rename-calendar.xml | 40 ++-- reference/icap/functions/icap-reopen.xml | 40 ++-- reference/icap/functions/icap-snooze.xml | 44 ++-- reference/icap/functions/icap-store-event.xml | 188 ++++++++--------- 12 files changed, 474 insertions(+), 487 deletions(-) diff --git a/reference/icap/functions/icap-close.xml b/reference/icap/functions/icap-close.xml index fa40175a75..72e88b000e 100644 --- a/reference/icap/functions/icap-close.xml +++ b/reference/icap/functions/icap-close.xml @@ -1,23 +1,23 @@ - + - - - icap_close - Close an ICAP stream - - - Description - - inticap_close - inticap_stream - intflags - - - Closes the given icap stream. - - - + + + icap_close + Close an ICAP stream + + + Description + + inticap_close + inticap_stream + intflags + + + Closes the given icap stream. + + + + - - - icap_create_calendar - - Create a new calendar - - - - Description - - stringicap_create_calendar - intstream_id - stringcalendar - - - &warn.undocumented.func; - - - + + + icap_create_calendar + Create a new calendar + + + Description + + stringicap_create_calendar + intstream_id + stringcalendar + + + &warn.undocumented.func; + + + + - - - icap_delete_calendar - - Delete a calendar - - - - Description - - stringicap_delete_calendar - intstream_id - stringcalendar - - - &warn.undocumented.func; - - - + + + icap_delete_calendar + Delete a calendar + + + Description + + stringicap_delete_calendar + intstream_id + stringcalendar + + + &warn.undocumented.func; + + + + - - - icap_delete_event - Delete an event from an ICAP calendar - - - Description - - stringicap_delete_event - intstream_id - intuid - - - icap_delete_event deletes the calendar event - specified by the uid. - - - Returns &true;. - - - + + + icap_delete_event + Delete an event from an ICAP calendar + + + Description + + stringicap_delete_event + intstream_id + intuid + + + icap_delete_event deletes the calendar event + specified by the uid. + + + Returns &true;. + + + + - - - icap_fetch_event - Fetches an event from the calendar stream/ - - - Description - - inticap_fetch_event - intstream_id - intevent_id - intoptions - - - icap_fetch_event fetches an event from the - calendar stream specified by event_id. - - - Returns an event object consisting of: - - - - int id - ID of that event. - - - - - int public - &true; if the event if public, &false; if it is private. - - - - - string category - Category string of the event. - - - - - string title - Title string of the event. - - - - - string description - Description string of the event. - - - - - int alarm - number of minutes before the event to send an - alarm/reminder. - - - - - object start - Object containing a datetime entry. - - - - - object end - Object containing a datetime entry. - - - - All datetime entries consist of an object that contains: - - - - int year - year - - - - - int month - month - - - - - int mday - day of month - - - - - int hour - hour - - - - - int min - minutes - - - - - int sec - seconds - - - - - + + + icap_fetch_event + Fetches an event from the calendar stream + + + Description + + inticap_fetch_event + intstream_id + intevent_id + intoptions + + + icap_fetch_event fetches an event from the + calendar stream specified by event_id. + + + Returns an event object consisting of: + + + + int id - ID of that event. + + + + + int public - &true; if the event if public, &false; if it is private. + + + + + string category - Category string of the event. + + + + + string title - Title string of the event. + + + + + string description - Description string of the event. + + + + + int alarm - number of minutes before the event to send an + alarm/reminder. + + + + + object start - Object containing a datetime entry. + + + + + object end - Object containing a datetime entry. + + + + All datetime entries consist of an object that contains: + + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + + + - - - icap_list_alarms - - Return a list of events that has an alarm triggered at the given - datetime - - - - Description - - inticap_list_alarms - intstream_id - arraydate - arraytime - - - Returns an array of event ID's that has an alarm going off at the - given datetime. - - - icap_list_alarms function takes in a - datetime for a calendar stream. An array of event id's that has - an alarm should be going off at the datetime are returned. - - - All datetime entries consist of an object that contains: - - - - int year - year - - - - - int month - month - - - - - int mday - day of month - - - - - int hour - hour - - - - - int min - minutes - - - - - int sec - seconds - - - - - - + + + icap_list_alarms + Return a list of events that has an alarm triggered at the given datetime + + + Description + + inticap_list_alarms + intstream_id + arraydate + arraytime + + + Returns an array of event ID's that has an alarm going off at the + given datetime. + + + icap_list_alarms function takes in a + datetime for a calendar stream. An array of event id's that has + an alarm should be going off at the datetime are returned. + + + All datetime entries consist of an object that contains: + + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + + + + - - - icap_list_events - - Return a list of events between two given datetimes - - - - Description - - arrayicap_list_events - intstream_id - intbegin_date - intend_date - - - Returns an array of event ID's that are between the two given - datetimes. - - - icap_list_events function takes in a - beginning datetime and an end datetime for a calendar stream. An - array of event id's that are between the given datetimes are - returned. - - - All datetime entries consist of an object that contains: - - - - int year - year - - - - - int month - month - - - - - int mday - day of month - - - - - int hour - hour - - - - - int min - minutes - - - - - int sec - seconds - - - - - - + + + icap_list_events + Return a list of events between two given datetimes + + + Description + + arrayicap_list_events + intstream_id + intbegin_date + intend_date + + + Returns an array of event ID's that are between the two given + datetimes. + + + icap_list_events function takes in a + beginning datetime and an end datetime for a calendar stream. An + array of event id's that are between the given datetimes are + returned. + + + All datetime entries consist of an object that contains: + + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + + + + - - - icap_open - Opens up an ICAP connection - - - Description - - resourceicap_open - stringcalendar - stringusername - stringpassword - stringoptions - - - Returns an ICAP stream on success, &false; on error. - - icap_open opens up an ICAP connection to the - specified calendar store. If the optional - options is specified, passes the - options to that mailbox also. - - - + + + icap_open + Opens up an ICAP connection + + + Description + + resourceicap_open + stringcalendar + stringusername + stringpassword + stringoptions + + + Returns an ICAP stream on success, &false; on error. + + icap_open opens up an ICAP connection to the + specified calendar store. If the optional + options is specified, passes the + options to that mailbox also. + + + + - - - icap_rename_calendar - - Rename a calendar - - - - Description - - stringicap_rename_calendar - intstream_id - stringold_name - stringnew_name - - - &warn.undocumented.func; - - - + + + icap_rename_calendar + Rename a calendar + + + Description + + stringicap_rename_calendar + intstream_id + stringold_name + stringnew_name + + + &warn.undocumented.func; + + + + - - - icap_reopen - - Reopen ICAP stream to new calendar - - - - Description - - inticap_reopen - intstream_id - stringcalendar - intoptions - - - &warn.undocumented.func; - - - + + + icap_reopen + Reopen ICAP stream to new calendar + + + Description + + inticap_reopen + intstream_id + stringcalendar + intoptions + + + &warn.undocumented.func; + + + + - - - icap_snooze - Snooze an alarm - - - Description - - stringicap_snooze - intstream_id - intuid - - - icap_snooze turns on an alarm for a - calendar event specified by the uid. - - - Returns &true;. - - - + + + icap_snooze + Snooze an alarm + + + Description + + stringicap_snooze + intstream_id + intuid + + + icap_snooze turns on an alarm for a + calendar event specified by the uid. + + + Returns &true;. + + + + - - - icap_store_event - Store an event into an ICAP calendar - - - Description - - stringicap_store_event - intstream_id - objectevent - - - icap_store_event Stores an event into - an ICAP calendar. An event object consists of: - - - - int public - 1 if public, 0 if private; - - - - - string category - Category string of the event. - - - - - string title - Title string of the event. - - - - - string description - Description string of the event. - - - - - int alarm - Number of minutes before the event to send out an alarm. - - - - - datetime start - datetime object of the start of the event. - - - - - datetime end - datetime object of the end of the event. - - - - - - All datetime entries consist of an object that contains: - - - - int year - year - - - - - int month - month - - - - - int mday - day of month - - - - - int hour - hour - - - - - int min - minutes - - - - - int sec - seconds - - - - - - Returns &true; on success and &false; on error. - - - + + + icap_store_event + Store an event into an ICAP calendar + + + Description + + stringicap_store_event + intstream_id + objectevent + + + icap_store_event Stores an event into + an ICAP calendar. An event object consists of: + + + + int public - 1 if public, 0 if private; + + + + + string category - Category string of the event. + + + + + string title - Title string of the event. + + + + + string description - Description string of the event. + + + + + int alarm - Number of minutes before the event to send out an alarm. + + + + + datetime start - datetime object of the start of the event. + + + + + datetime end - datetime object of the end of the event. + + + + + + All datetime entries consist of an object that contains: + + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + + + Returns &true; on success and &false; on error. + + +