 |
 |
 |
 |
|
|
Date: 09/12/99
- Next message: Gurbaksh Chahal: "[PHP-DEV] PHP/MySQL Developers Needed"
- Previous message: Zeev Suraski: "[PHP-DEV] adapt_uris()"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
eschmid Sun Sep 12 04:56:59 1999 EDT
Modified files:
/phpdoc/functions mcal.sgml
Log:
Some minor corrections. Mark are the return and parameter types correct?
Index: phpdoc/functions/mcal.sgml
diff -u phpdoc/functions/mcal.sgml:1.4 phpdoc/functions/mcal.sgml:1.5
--- phpdoc/functions/mcal.sgml:1.4 Sat Sep 11 13:25:51 1999
+++ phpdoc/functions/mcal.sgml Sun Sep 12 04:56:58 1999
@@ -73,11 +73,11 @@
<refsect1>
<title>Description</title>
<funcsynopsis>
- <funcdef>stream <function>mcal_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>
+ <funcdef>int <function>mcal_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>
</funcsynopsis>
<para>
Returns an MCAL stream on success, false on error.
@@ -119,10 +119,10 @@
<refsect1>
<title>Description</title>
<funcsynopsis>
- <funcdef>object<function>mcal_fetch_event</function></funcdef>
- <paramdef>stream<parameter>mcal_stream</parameter></paramdef>
- <paramdef>id<parameter>event id</parameter></paramdef>
- <paramdef>options<parameter>options</parameter></paramdef>
+ <funcdef>object <function>mcal_fetch_event</function></funcdef>
+ <paramdef>int <parameter>mcal_stream</parameter></paramdef>
+ <paramdef>int <parameter>event_id</parameter></paramdef>
+ <paramdef>int <parameter>options</parameter></paramdef>
</funcsynopsis>
<para>
<function>mcal_fetch_event</function> fetches an event from the
@@ -191,13 +191,25 @@
<title>Description</title>
<funcsynopsis>
<funcdef>array <function>mcal_list_events</function></funcdef>
- <paramdef>stream <parameter>mcal_stream</parameter></paramdef>
- <paramdef>[int <parameter>begin_year</parameter></paramdef>
- <paramdef>int <parameter>begin_month</parameter></paramdef>
- <paramdef>int <parameter>begin_day</parameter></paramdef>
- <paramdef>int <parameter>end_year</parameter></paramdef>
- <paramdef>int <parameter>end_month</parameter></paramdef>
- <paramdef>int <parameter>end_day]</parameter></paramdef>
+ <paramdef>int <parameter>mcal_stream</parameter></paramdef>
+ <paramdef>int
+ <parameter><optional>begin_year</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>begin_month</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>begin_day</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>end_year</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>end_month</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>end_day</optional></parameter>
+ </paramdef>
</funcsynopsis>
<para>
Returns an array of event ID's that are between the start and end
@@ -255,7 +267,7 @@
<refentry id="function.mcal-snooze">
<refnamediv>
<refname>mcal_snooze</refname>
- <refpurpose>turn off an alarm for an event</refpurpose>
+ <refpurpose>Turn off an alarm for an event</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -275,25 +287,38 @@
<refnamediv>
<refname>mcal_list_alarms</refname>
<refpurpose>
- Return a list of events that has an alarm triggered at the given datetime
+ Return a list of events that has an alarm triggered at the given
+ datetime
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>array <function>mcal_list_events</function></funcdef>
- <paramdef>stream <parameter>mcal_stream</parameter></paramdef>
- <paramdef>[int <parameter>begin_year</parameter></paramdef>
- <paramdef>int <parameter>begin_month</parameter></paramdef>
- <paramdef>int <parameter>begin_day</parameter></paramdef>
- <paramdef>int <parameter>end_year</parameter></paramdef>
- <paramdef>int <parameter>end_month</parameter></paramdef>
- <paramdef>int <parameter>end_day]</parameter></paramdef>
+ <paramdef>int <parameter>mcal_stream</parameter></paramdef>
+ <paramdef>int
+ <parameter><optional>begin_year</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>begin_month</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>begin_day</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>end_year</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>end_month</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>end_day</optional></parameter>
+ </paramdef>
</funcsynopsis>
<para>
- Returns an array of event ID's that has an alarm going offbetween
- the start and end dates, or if just a stream is given, uses the
- start and end dates in the global event structure.
+ Returns an array of event ID's that has an alarm going off
+ between the start and end dates, or if just a stream is given,
+ uses the start and end dates in the global event structure.
<para>
<function>mcal_list_events</function> function takes in an
optional beginning date and an end date for a calendar stream. An
@@ -306,7 +331,7 @@
<refnamediv>
<refname>mcal_event_init</refname>
<refpurpose>
- initializes a streams global event structure
+ Initializes a streams global event structure
</refpurpose>
</refnamediv>
<refsect1>
@@ -449,10 +474,26 @@
<paramdef>int <parameter>stream</parameter></paramdef>
<paramdef>int <parameter>year</parameter></paramdef>
<paramdef>int <parameter>month</parameter></paramdef>
- <paramdef>[int <parameter>day</parameter></paramdef>
- <paramdef>int <parameter>hour</parameter></paramdef>
- <paramdef>int <parameter>min</parameter></paramdef>
- <paramdef>int <parameter>sec]</parameter></paramdef>
+ <paramdef>int
+ <parameter>
+ <optional>day</optional>
+ </parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>
+ <optional>hour</optional>
+ </parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>
+ <optional>min</optional>
+ </parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter>
+ <optional>sec</optional>
+ </parameter>
+ </paramdef>
</funcsynopsis>
<para>
<function>mcal_event_set_end</function> sets the streams global
@@ -522,8 +563,8 @@
<paramdef>int <parameter>year</parameter></paramdef>
</funcsynopsis>
<para>
- <function>mcal_is_leap_year</function>
-returns 1 if the given year is a leap year, 1 if not.
+ <function>mcal_is_leap_year</function> returns 1 if the given
+ year is a leap year, 1 if not.
</refsect1>
</refentry>
@@ -879,8 +920,8 @@
int recur_data - recurrence data
</itemizedlist>
-
All datetime entries consist of an object that contains:
+
<itemizedlist>
<listitem><simpara>
int year - year
-- PHP Development Mailing List <http://www.php.net/> To unsubscribe, e-mail: php-dev-unsubscribe <email protected> For additional commands, e-mail: php-dev-help <email protected> To contact the list administrators, e-mail: php-list-admin <email protected>
- Next message: Gurbaksh Chahal: "[PHP-DEV] PHP/MySQL Developers Needed"
- Previous message: Zeev Suraski: "[PHP-DEV] adapt_uris()"
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]