cvs: phpdoc /en/reference/mcal/functions mcal-snooze.xml

jmcastagnetto Fri Jun 20 22:07:07 2003 EDT Modified files: /phpdoc/en/reference/mcal/functions mcal-snooze.xml Log: Fixing prototype to match the actual code. Re: user note. Index: phpdoc/en/reference/mcal/functions/mcal-snooze.xml diff -u phpdoc/en/reference/mcal/functions/mcal-snooze.xml:1.2 phpdoc/en/reference/mcal/functions/mcal-snooze.xml:1.3 --- phpdoc/en/reference/mcal/functions/mcal-snooze.xml:1.2 Wed Apr 17 02:40:06 2002 +++ phpdoc/en/reference/mcal/functions/mcal-snooze.xml Fri Jun 20 22:07:07 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 --> <refentry id="function.mcal-snooze"> <refnamediv> @@ -9,15 +9,17 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>mcal_snooze</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <type>boolean</type><methodname>mcal_snooze</methodname> + <methodparam><type>int</type><parameter>stream_id</parameter></methodparam> + <methodparam><type>int</type><parameter>event_id</parameter></methodparam> </methodsynopsis> <para> <function>mcal_snooze</function> turns off an alarm for a - calendar event specified by the id. + calendar event specified by the <parameter>stream_id</parameter> and + <parameter>event_id</parameter>. </para> <para> - Returns &true;. + Returns &true; on success, &false; otherwise. </para> </refsect1> </refentry>