 |
 |
 |
 |
|
|
Date: 07/29/00
- Next message: Egon Schmid: "[PHP-DOC] cvs: phpdoc /en/functions strings.xml"
- Previous message: Monte Ohrt: "[PHP-DOC] cvs: phpdoc /en/functions pcre.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
eschmid Sat Jul 29 06:43:34 2000 EDT
Modified files:
/phpdoc/en/functions icap.xml
Log:
Argument types from function protos.
Index: phpdoc/en/functions/icap.xml
diff -u phpdoc/en/functions/icap.xml:1.5 phpdoc/en/functions/icap.xml:1.6
--- phpdoc/en/functions/icap.xml:1.5 Thu Jul 13 13:03:21 2000
+++ phpdoc/en/functions/icap.xml Sat Jul 29 06:43:34 2000
@@ -21,10 +21,10 @@
<funcsynopsis>
<funcprototype>
<funcdef>stream <function>icap_open</function></funcdef>
- <paramdef>string<parameter>calendar</parameter></paramdef>
- <paramdef>string<parameter>username</parameter></paramdef>
- <paramdef>string<parameter>password</parameter></paramdef>
- <paramdef>string<parameter>options</parameter></paramdef>
+ <paramdef>string <parameter>calendar</parameter></paramdef>
+ <paramdef>string <parameter>username</parameter></paramdef>
+ <paramdef>string <parameter>password</parameter></paramdef>
+ <paramdef>string <parameter>options</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@@ -49,11 +49,14 @@
<funcprototype>
<funcdef>int <function>icap_close</function></funcdef>
<paramdef>int <parameter>icap_stream</parameter></paramdef>
- <paramdef>int <parameter>flags</parameter></paramdef>
+ <paramdef>int
+ <parameter><optional>flags</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
<para>
- Closes the given icap stream.</para>
+ Closes the given icap stream.
+ </para>
</refsect1>
</refentry>
@@ -66,15 +69,17 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>object<function>icap_fetch_event</function></funcdef>
- <paramdef>stream<parameter>icap_stream</parameter></paramdef>
- <paramdef>id<parameter>event id</parameter></paramdef>
- <paramdef>options<parameter>options</parameter></paramdef>
+ <funcdef>int <function>icap_fetch_event</function></funcdef>
+ <paramdef>int <parameter>stream_id</parameter></paramdef>
+ <paramdef>int <parameter>event_id</parameter></paramdef>
+ <paramdef>int
+ <parameter><optional>options</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>icap_fetch_event</function> fetches an event from the
- calendar stream specified by <parameter>id</parameter>.
+ <function>Icap_fetch_event</function> fetches an event from the
+ calendar stream specified by <parameter>event_id</parameter>.
</para>
<para>
Returns an event object consisting of:
@@ -169,9 +174,11 @@
<funcsynopsis>
<funcprototype>
<funcdef>array <function>icap_list_events</function></funcdef>
- <paramdef>stream <parameter>icap_stream</parameter></paramdef>
- <paramdef>datetime <parameter>begin_date</parameter></paramdef>
- <paramdef>datetime <parameter>end_date</parameter></paramdef>
+ <paramdef>int <parameter>stream_id</parameter></paramdef>
+ <paramdef>int <parameter>begin_date</parameter></paramdef>
+ <paramdef>int
+ <parameter><optional>end_date</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
<para>
@@ -179,7 +186,7 @@
datetimes.
</para>
<para>
- <function>icap_list_events</function> function takes in a
+ <function>Icap_list_events</function> 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.
@@ -231,15 +238,14 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>icap_store_event</function></funcdef>
- <paramdef>int <parameter>icap_stream</parameter></paramdef>
+ <funcdef>string <function>icap_store_event</function></funcdef>
+ <paramdef>int <parameter>stream_id</parameter></paramdef>
<paramdef>object <parameter>event</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>icap_store_event</function> Stores an event into
- an ICAP calendar.
- an event object consists of:
+ <function>Icap_store_event</function> Stores an event into
+ an ICAP calendar. An event object consists of:
<itemizedlist>
<listitem>
<simpara>
@@ -328,12 +334,13 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>icap_delete_event</function></funcdef>
+ <funcdef>string <function>icap_delete_event</function></funcdef>
+ <paramdef>int <parameter>sream_id</parameter></paramdef>
<paramdef>int <parameter>uid</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>icap_delete_event</function> deletes the calendar event
+ <function>Icap_delete_event</function> deletes the calendar event
specified by the <parameter>uid</parameter>.
</para>
<para>
@@ -345,18 +352,19 @@
<refentry id="function.icap-snooze">
<refnamediv>
<refname>icap_snooze</refname>
- <refpurpose>turn off an alarm for an event</refpurpose>
+ <refpurpose>Snooze an alarm</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>icap_snooze</function></funcdef>
+ <funcdef>string <function>icap_snooze</function></funcdef>
+ <paramdef>int <parameter>stream_id</parameter></paramdef>
<paramdef>int <parameter>uid</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>icap_snooze</function> turns off an alarm for a
+ <function>Icap_snooze</function> turns on an alarm for a
calendar event specified by the <parameter>uid</parameter>.
</para>
<para>
@@ -377,9 +385,10 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>array <function>icap_list_alarms</function></funcdef>
- <paramdef>stream <parameter>icap_stream</parameter></paramdef>
- <paramdef>datetime <parameter>alarm_date</parameter></paramdef>
+ <funcdef>int <function>icap_list_alarms</function></funcdef>
+ <paramdef>int <parameter>stream_id</parameter></paramdef>
+ <paramdef>array <parameter>date</parameter></paramdef>
+ <paramdef>array <parameter>time</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
@@ -387,7 +396,7 @@
given datetime.
</para>
<para>
- <function>icap_list_alarms</function> function takes in a
+ <function>Icap_list_alarms</function> 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.
</para>
- Next message: Egon Schmid: "[PHP-DOC] cvs: phpdoc /en/functions strings.xml"
- Previous message: Monte Ohrt: "[PHP-DOC] cvs: phpdoc /en/functions pcre.xml"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]