[PHP-DOC] cvs: phpdoc / manual.xml.in /en chapters.ent /en/functions icap.xml From: Egon Schmid (eschmid <email protected>)
Date: 07/13/00

eschmid Thu Jul 13 13:03:21 2000 EDT

  Modified files:
    /phpdoc manual.xml.in
    /phpdoc/en chapters.ent
    /phpdoc/en/functions icap.xml
  Log:
  This was lost in the documentation.
  
Index: phpdoc/manual.xml.in
diff -u phpdoc/manual.xml.in:1.10 phpdoc/manual.xml.in:1.11
--- phpdoc/manual.xml.in:1.10 Fri Jul 7 20:38:18 2000
+++ phpdoc/manual.xml.in Thu Jul 13 13:03:21 2000
@@ -109,6 +109,7 @@
   &reference.gettext;
   &reference.http;
   &reference.hw;
+ &reference.icap;
   &reference.image;
   &reference.imap;
   &reference.ifx;
Index: phpdoc/en/chapters.ent
diff -u phpdoc/en/chapters.ent:1.6 phpdoc/en/chapters.ent:1.7
--- phpdoc/en/chapters.ent:1.6 Mon May 22 20:41:07 2000
+++ phpdoc/en/chapters.ent Thu Jul 13 13:03:21 2000
@@ -51,6 +51,7 @@
 <!ENTITY reference.http SYSTEM "functions/http.xml">
 <!ENTITY reference.hw SYSTEM "functions/hw.xml">
 <!ENTITY reference.ibase SYSTEM "functions/ibase.xml">
+<!ENTITY reference.icap SYSTEM "functions/icap.xml">
 <!ENTITY reference.ifx SYSTEM "functions/ifx.xml">
 <!ENTITY reference.image SYSTEM "functions/image.xml">
 <!ENTITY reference.imap SYSTEM "functions/imap.xml">
@@ -80,7 +81,7 @@
 <!ENTITY reference.session SYSTEM "functions/session.xml">
 <!ENTITY reference.snmp SYSTEM "functions/snmp.xml">
 <!ENTITY reference.strings SYSTEM "functions/strings.xml">
-<!ENTITY reference.swf SYSTEM "functions/swf.xml">
+<!ENTITY reference.swf SYSTEM "functions/swf.xml">
 <!ENTITY reference.uodbc SYSTEM "functions/uodbc.xml">
 <!ENTITY reference.url SYSTEM "functions/url.xml">
 <!ENTITY reference.var SYSTEM "functions/var.xml">
Index: phpdoc/en/functions/icap.xml
diff -u phpdoc/en/functions/icap.xml:1.4 phpdoc/en/functions/icap.xml:1.5
--- phpdoc/en/functions/icap.xml:1.4 Sat Jun 24 00:38:43 2000
+++ phpdoc/en/functions/icap.xml Thu Jul 13 13:03:21 2000
@@ -1,13 +1,14 @@
  <reference id="ref.icap">
- <title>ICAP functions</title>
+ <title>ICAP Functions</title>
   <titleabbrev>ICAP</titleabbrev>
 
   <partintro>
    <simpara>
     To get these functions to work, you have to compile PHP with
     <option role="configure">--with-icap</option>. That requires the
- icap library to be installed. Grab the latest version from <ulink url="&url.icap;">&url.icap;</ulink> and
- compile and install it.</simpara>
+ icap library to be installed. Grab the latest version from <ulink
+ url="&url.icap;">&url.icap;</ulink> and compile and install it.
+ </simpara>
   </partintro>
 
   <refentry id="function.icap-open">
@@ -32,12 +33,11 @@
      <function>icap_open</function> opens up an ICAP connection to the
      specified <parameter>calendar</parameter> store. If the optional
      <parameter>options</parameter> is specified, passes the
- <parameter>options</parameter> to that mailbox also.</para>
- <para></para>
+ <parameter>options</parameter> to that mailbox also.
+ </para>
    </refsect1>
   </refentry>
 
-
   <refentry id="function.icap-close">
    <refnamediv>
     <refname>icap_close</refname>
@@ -74,56 +74,94 @@
     </funcsynopsis>
     <para>
      <function>icap_fetch_event</function> fetches an event from the
- calendar stream specified by <parameter>id</parameter>.</para>
+ calendar stream specified by <parameter>id</parameter>.
+ </para>
     <para>
      Returns an event object consisting of:
-
      <itemizedlist>
- <listitem><simpara>
- int id - ID of that event.</simpara></listitem>
- <listitem><simpara>
- int public - TRUE if the event if public, FALSE if it is private.</simpara></listitem>
- <listitem><simpara>
- string category - Category string of the event.</simpara></listitem>
- <listitem><simpara>
- string title - Title string of the event.</simpara></listitem>
- <listitem><simpara>
- string description - Description string of the event.</simpara></listitem>
- <listitem><simpara>
+ <listitem>
+ <simpara>
+ int id - ID of that event.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int public - TRUE if the event if public, FALSE if it is private.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ string category - Category string of the event.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ string title - Title string of the event.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ string description - Description string of the event.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
         int alarm - number of minutes before the event to send an
- alarm/reminder.</simpara></listitem>
- <listitem><simpara>
- object start - Object containing a datetime entry.</simpara></listitem>
- <listitem><simpara>
- object end - Object containing a datetime entry.</simpara></listitem>
+ alarm/reminder.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ object start - Object containing a datetime entry.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ object end - Object containing a datetime entry.
+ </simpara>
+ </listitem>
      </itemizedlist>
-
      All datetime entries consist of an object that contains:
      <itemizedlist>
- <listitem><simpara>
- int year - year</simpara></listitem>
- <listitem><simpara>
- int month - month</simpara></listitem>
- <listitem><simpara>
- int mday - day of month</simpara></listitem>
- <listitem><simpara>
- int hour - hour</simpara></listitem>
- <listitem><simpara>
- int min - minutes</simpara></listitem>
- <listitem><simpara>
- int sec - seconds</simpara></listitem>
- </itemizedlist></para>
-
+ <listitem>
+ <simpara>
+ int year - year
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int month - month
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int mday - day of month
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int hour - hour
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int min - minutes
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int sec - seconds
+ </simpara></listitem>
+ </itemizedlist>
+ </para>
    </refsect1>
   </refentry>
   
-
   <refentry id="function.icap-list-events">
    <refnamediv>
     <refname>icap_list_events</refname>
-
- <refpurpose>Return a list of events between two given
- datetimes
+ <refpurpose>
+ Return a list of events between two given datetimes
     </refpurpose>
    </refnamediv>
    <refsect1>
@@ -138,33 +176,52 @@
     </funcsynopsis>
     <para>
      Returns an array of event ID's that are between the two given
- datetimes.</para>
+ datetimes.
+ </para>
     <para>
      <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.</para>
+ returned.
+ </para>
     <para>
      All datetime entries consist of an object that contains:
-
      <itemizedlist>
- <listitem><simpara>
- int year - year</simpara></listitem>
- <listitem><simpara>
- int month - month</simpara></listitem>
- <listitem><simpara>
- int mday - day of month</simpara></listitem>
- <listitem><simpara>
- int hour - hour</simpara></listitem>
- <listitem><simpara>
- int min - minutes</simpara></listitem>
- <listitem><simpara>
- int sec - seconds</simpara></listitem>
- </itemizedlist></para>
+ <listitem>
+ <simpara>
+ int year - year
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int month - month
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int mday - day of month
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int hour - hour
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int min - minutes
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int sec - seconds
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
    </refsect1>
   </refentry>
 
-
   <refentry id="function.icap-store-event">
    <refnamediv>
     <refname>icap_store_event</refname>
@@ -183,49 +240,85 @@
      <function>icap_store_event</function> Stores an event into
      an ICAP calendar.
      an event object consists of:
-
      <itemizedlist>
- <listitem><simpara>
- int public - 1 if public, 0 if private;</simpara></listitem>
- <listitem><simpara>
- string caegory - Category string of the event.</simpara></listitem>
- <listitem><simpara>
- string title - Title string of the event.</simpara></listitem>
- <listitem><simpara>
- string description - Description string of the event.</simpara></listitem>
- <listitem><simpara>
- int alarm - Number of minutes before the event to sned out an alarm.</simpara></listitem>
- <listitem><simpara>
- datetime start - datetime object of the start of the event.</simpara></listitem>
- <listitem><simpara>
- datetime end - datetime object of the end of the event.</simpara></listitem>
- </itemizedlist></para>
-
+ <listitem>
+ <simpara>
+ int public - 1 if public, 0 if private;
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ string caegory - Category string of the event.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ string title - Title string of the event.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ string description - Description string of the event.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int alarm - Number of minutes before the event to sned out an alarm.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ datetime start - datetime object of the start of the event.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ datetime end - datetime object of the end of the event.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
     <para>
      All datetime entries consist of an object that contains:
-
      <itemizedlist>
- <listitem><simpara>
- int year - year</simpara></listitem>
- <listitem><simpara>
- int month - month</simpara></listitem>
- <listitem><simpara>
- int mday - day of month</simpara></listitem>
- <listitem><simpara>
- int hour - hour</simpara></listitem>
- <listitem><simpara>
- int min - minutes</simpara></listitem>
- <listitem><simpara>
- int sec - seconds</simpara></listitem>
- </itemizedlist></para>
-
+ <listitem>
+ <simpara>
+ int year - year
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int month - month
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int mday - day of month
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int hour - hour
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int min - minutes
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int sec - seconds
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
     <para>
- Returns true on success and false on error.</para>
- <para></para>
+ Returns true on success and false on error.
+ </para>
    </refsect1>
   </refentry>
 
-
   <refentry id="function.icap-delete-event">
    <refnamediv>
     <refname>icap_delete_event</refname>
@@ -241,9 +334,11 @@
     </funcsynopsis>
     <para>
      <function>icap_delete_event</function> deletes the calendar event
- specified by the uid.</para>
+ specified by the <parameter>uid</parameter>.
+ </para>
     <para>
- Returns true.</para>
+ Returns true.
+ </para>
    </refsect1>
   </refentry>
 
@@ -262,9 +357,11 @@
     </funcsynopsis>
     <para>
      <function>icap_snooze</function> turns off an alarm for a
- calendar event specified by the uid.</para>
+ calendar event specified by the <parameter>uid</parameter>.
+ </para>
     <para>
- Returns true.</para>
+ Returns true.
+ </para>
    </refsect1>
   </refentry>
 
@@ -287,27 +384,48 @@
     </funcsynopsis>
     <para>
      Returns an array of event ID's that has an alarm going off at the
- given datetime.</para>
+ given datetime.
+ </para>
     <para>
      <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>
+ an alarm should be going off at the datetime are returned.
+ </para>
     <para>
      All datetime entries consist of an object that contains:
      <itemizedlist>
- <listitem><simpara>
- int year - year</simpara></listitem>
- <listitem><simpara>
- int month - month</simpara></listitem>
- <listitem><simpara>
- int mday - day of month</simpara></listitem>
- <listitem><simpara>
- int hour - hour</simpara></listitem>
- <listitem><simpara>
- int min - minutes</simpara></listitem>
- <listitem><simpara>
- int sec - seconds</simpara></listitem>
- </itemizedlist></para>
+ <listitem>
+ <simpara>
+ int year - year
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int month - month
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int mday - day of month
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int hour - hour
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int min - minutes
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ int sec - seconds
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
    </refsect1>
   </refentry>
 
@@ -323,7 +441,7 @@
 sgml-indent-step:1
 sgml-indent-data:t
 sgml-parent-document:nil
-sgml-default-dtd-file:"../manual.ced"
+sgml-default-dtd-file:"../../manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil