sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-17 01:18:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Switch to new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249391 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-12-30 00:52:46 +00:00
parent 7439959e0b
commit e5253c311b
24 changed files with 771 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
reference/mcal/functions/mcal-append-event.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.3 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-append-event" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_append_event</refname>
<refpurpose>Store a new event into an MCAL calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mcal_append_event</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
@ -16,6 +15,24 @@
<function>mcal_append_event</function> stores the global event
into an MCAL calendar for the stream <parameter>mcal_stream</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mcal_stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the id of the newly inserted event.
</para>

35
reference/mcal/functions/mcal-close.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.11 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mcal-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_close</refname>
<refpurpose>Close an MCAL stream</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_close</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
@ -17,6 +16,34 @@
Closes the given mcal stream.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

36
reference/mcal/functions/mcal-create-calendar.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.11 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-create-calendar" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_create_calendar</refname>
<refpurpose>Create a new MCAL calendar </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_create_calendar</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
@ -17,6 +16,35 @@
Creates a new calendar named <parameter>calendar</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
The calendar name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

47
reference/mcal/functions/mcal-date-valid.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-date-valid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_date_valid</refname>
<refpurpose>Returns &true; if the given year, month, day is a valid date</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_date_valid</methodname>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
@ -15,8 +14,44 @@
<methodparam><type>int</type><parameter>day</parameter></methodparam>
</methodsynopsis>
<para>
<function>mcal_date_valid</function> Returns &true; if the given
year, month and day is a valid date, &false; if not.
<function>mcal_date_valid</function>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
The month.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
The day.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the given date is valid, &false; otherwise.
</para>
</refsect1>
</refentry>

36
reference/mcal/functions/mcal-delete-calendar.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mcal-delete-calendar" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_delete_calendar</refname>
<refpurpose>Delete an MCAL calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_delete_calendar</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
@ -17,6 +16,35 @@
Deletes the calendar named <parameter>calendar</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
The calendar name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/mcal/functions/mcal-delete-event.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mcal-delete-event" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_delete_event</refname>
<refpurpose>Delete an event from an MCAL calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_delete_event</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
@ -17,6 +16,32 @@
<function>mcal_delete_event</function> deletes the calendar event
specified by the event_id.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mcal_stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_id</parameter></term>
<listitem>
<para>
The event identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true;.
</para>

30
reference/mcal/functions/mcal-event-init.xml
View file

@ -1,23 +1,43 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-event-init" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_event_init</refname>
<refpurpose>Initializes a streams global event structure</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>mcal_event_init</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
<function>mcal_event_init</function> initializes a streams global
event structure. this effectively sets all elements of the
event structure. This effectively sets all elements of the
structure to 0, or the default settings.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

36
reference/mcal/functions/mcal-event-set-category.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-event-set-category" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_event_set_category</refname>
<refpurpose>Sets the category of the streams global event structure</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>mcal_event_set_category</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
@ -18,6 +17,35 @@
global event structure's category to the given string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>category</parameter></term>
<listitem>
<para>
The category to be set.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

28
reference/mcal/functions/mcal-event-set-recur-none.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-event-set-recur-none" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_event_set_recur_none</refname>
<refpurpose>Sets the recurrence of the streams global event structure</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>mcal_event_set_recur_none</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
@ -18,6 +17,27 @@
<constant>MCAL_RECUR_NONE</constant>).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

36
reference/mcal/functions/mcal-event-set-title.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-event-set-title" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_event_set_title</refname>
<refpurpose>Sets the title of the streams global event structure</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>mcal_event_set_title</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
@ -18,6 +17,35 @@
event structure's title to the given string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>title</parameter></term>
<listitem>
<para>
The new title.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

35
reference/mcal/functions/mcal-expunge.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.28 -->
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.mcal-expunge" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_expunge</refname>
<refpurpose>Deletes all events marked for being expunged</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_expunge</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
@ -17,6 +16,34 @@
been previously marked for deletion.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

32
reference/mcal/functions/mcal-is-leap-year.xml
View file

@ -1,20 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-is-leap-year" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_is_leap_year</refname>
<refpurpose>Returns if the given year is a leap year or not</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_is_leap_year</methodname>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
</methodsynopsis>
<para>
<function>mcal_is_leap_year</function> returns 1 if the given
year is a leap year, 0 if not.
<function>mcal_is_leap_year</function> tells if the given
<parameter>year</parameter> is a leap year, or not.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The tested year.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the given year is a leap year, &false; otherwise.
</para>
</refsect1>
</refentry>

62
reference/mcal/functions/mcal-open.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.mcal-open" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_open</refname>
<refpurpose>Opens up an MCAL connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mcal_open</methodname>
<methodparam><type>string</type><parameter>calendar</parameter></methodparam>
@ -15,15 +14,56 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Returns an MCAL stream on success, &false; on error.
</para>
<para>
<function>mcal_open</function> opens up an MCAL 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. The streams
internal event structure is also initialized upon connection.
specified <parameter>calendar</parameter> store.
The streams internal event structure is also initialized upon connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
The MCAL calendar store.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The MCAL username.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The MCAL password.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
If the optional <parameter>options</parameter> is specified,
passes the <parameter>options</parameter> to that mailbox also.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an MCAL stream on success, &false; on error.
</para>
</refsect1>
</refentry>

44
reference/mcal/functions/mcal-rename-calendar.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.11 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-rename-calendar" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_rename_calendar</refname>
<refpurpose>Rename an MCAL calendar </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_rename_calendar</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
@ -19,6 +18,43 @@
<parameter>new_name</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>old_name</parameter></term>
<listitem>
<para>
The old name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>new_name</parameter></term>
<listitem>
<para>
The new name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

51
reference/mcal/functions/mcal-reopen.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.11 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mcal-reopen" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_reopen</refname>
<refpurpose>Reopens an MCAL connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcal_reopen</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
@ -18,10 +17,46 @@
Reopens an MCAL stream to a new calendar.
</para>
<para>
<function>mcal_reopen</function> reopens an MCAL 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.
<function>mcal_reopen</function> reopens an MCAL connection to the
specified <parameter>calendar</parameter> store.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mcal_stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>calendar</parameter></term>
<listitem>
<para>
The calendar store.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
If the optional <parameter>options</parameter> is specified,
passes the <parameter>options</parameter> to that mailbox also.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

38
reference/mcal/functions/mcal-snooze.xml
View file

@ -1,23 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.mcal-snooze" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_snooze</refname>
<refpurpose>Turn off an alarm for an event</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</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 <parameter>stream_id</parameter> and
<parameter>event_id</parameter>.
<function>mcal_snooze</function> turns off an alarm for a the given
calendar event.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream_id</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_id</parameter></term>
<listitem>
<para>
The event identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>

25
reference/mcal/functions/mcal-store-event.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.mcal-store-event" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_store_event</refname>
<refpurpose>Modify an existing event in an MCAL calendar</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mcal_store_event</methodname>
<methodparam><type>int</type><parameter>mcal_stream</parameter></methodparam>
@ -16,6 +15,24 @@
<function>mcal_store_event</function> stores the modifications
to the current global event for the given stream.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mcal_stream</parameter></term>
<listitem>
<para>
The MCAL stream.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the event id of the modified event on success and &false; on error.
</para>

44
reference/mcal/functions/mcal-week-of-year.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcal.xml, last change in rev 1.8 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id='function.mcal-week-of-year' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcal_week_of_year</refname>
<refpurpose>Returns the week number of the given date</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mcal_week_of_year</methodname>
<methodparam><type>int</type><parameter>day</parameter></methodparam>
@ -19,6 +18,43 @@
given date.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>day</parameter></term>
<listitem>
<para>
The day.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>month</parameter></term>
<listitem>
<para>
The month.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>year</parameter></term>
<listitem>
<para>
The year.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the week number.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

45
reference/tidy/functions/ob-tidyhandler.xml
View file

@ -1,12 +1,12 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.ob-tidyhandler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_tidyhandler</refname>
<refpurpose>ob_start callback function to repair the buffer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ob_tidyhandler</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
@ -16,6 +16,38 @@
<function>ob_tidyhandler</function> is intended to be used as a
callback function for <function>ob_start</function> to repair the buffer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
The buffer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
The buffer mode.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the modified buffer.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ob_tidyhandler</function> example</title>
@ -44,8 +76,13 @@ echo '<p>test</i>';
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>ob_start</function>.
<simplelist>
<member><function>ob_start</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

60
reference/tidy/functions/tidy-access-count.xml
View file

@ -1,12 +1,12 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-access-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_access_count</refname>
<refpurpose>Returns the Number of Tidy accessibility warnings encountered for specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>tidy_access_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
@ -15,15 +15,30 @@
<function>tidy_access_count</function> returns the number of
accessibility warnings found for the specified document.
</para>
<note>
<para>
Due to the design of the TidyLib, you must call
<function>tidy_diagnose</function> before
<function>tidy_access_count</function> or it will return always
<literal>0</literal>. You must also need to enable the
<literal>accessibility-check</literal> option.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
The Tidy object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of warnings.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>tidy_access_count</function> example</title>
@ -57,9 +72,26 @@ echo tidy_access_count($tidy); //5
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Due to the design of the TidyLib, you must call
<function>tidy_diagnose</function> before
<function>tidy_access_count</function> or it will return always
<literal>0</literal>. You must also need to enable the
<literal>accessibility-check</literal> option.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>tidy_error_count</function> and
<function>tidy_warning_count</function>.
<simplelist>
<member><function>tidy_error_count</function></member>
<member><function>tidy_warning_count</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

36
reference/tidy/functions/tidy-load-config.xml
View file

@ -1,12 +1,12 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-load-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_load_config</refname>
<refpurpose>Load an ASCII Tidy configuration file with the specified encoding</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>tidy_load_config</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
@ -16,6 +16,36 @@
This function loads a Tidy configuration file, with the specified
<parameter>encoding</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.tidy.1only;
</refsect1>
</refentry>

10
reference/tidy/functions/tidy-node-get-nodes.xml
View file

@ -1,19 +1,17 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-node-get-nodes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->get_nodes</refname>
<refpurpose>Return an array of nodes under this node with the specified id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>tidy_node->get_nodes</methodname>
<methodparam><type>int</type><parameter>node_id</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>

39
reference/tidy/functions/tidy-set-encoding.xml
View file

@ -1,23 +1,46 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.tidy-set-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_set_encoding</refname>
<refpurpose>Set the input/output character encoding for parsing markup</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidy_set_encoding</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
Sets the encoding for input/output documents. &return.success;
Possible values for <parameter>encoding</parameter> are
ascii, latin0, latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16,
utf16le, utf16be, big5 and shiftjis
Sets the encoding for input/output documents.
</para>
&note.tidy.1only;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
Possible values for <parameter>encoding</parameter> are ascii, latin0,
latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16, utf16le,
utf16be, big5 and shiftjis.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.tidy.1only;
</refsect1>
</refentry>

39
reference/tidy/functions/tidy-warning-count.xml
View file

@ -1,12 +1,12 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-warning-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_warning_count</refname>
<refpurpose>Returns the Number of Tidy warnings encountered for specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>tidy_warning_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
@ -15,6 +15,30 @@
<function>tidy_warning_count</function> returns the number of Tidy warnings
encountered for the specified document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
The Tidy object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of warnings.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>tidy_warning_count</function> example</title>
@ -33,9 +57,14 @@ echo tidy_warning_count($tidy) . "\n"; //5
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>tidy_access_count</function> and
<function>tidy_error_count</function>.
<simplelist>
<member><function>tidy_error_count</function></member>
<member><function>tidy_access_count</function></member>
</simplelist>
</para>
</refsect1>
</refentry>