[DOC-CVS] [doc-en] master: event: fix XML to get remove of useless wrapping para tags (#5114)
[email protected] (Gina Peter Banyard via GitHub)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Committer: GitHub (web-flow)
Pusher: Girgias
Date: 2026-01-15T22:50:55Z
Commit: https://github.com/php/doc-en/commit/a47dff201e3f65c07f6c84a535951632771cf72d
Raw diff: https://github.com/php/doc-en/commit/a47dff201e3f65c07f6c84a535951632771cf72d.diff
event: fix XML to get remove of useless wrapping para tags (#5114)
Changed paths:
M reference/event/event.callbacks.xml
M reference/event/eventbase/dispatch.xml
M reference/event/eventbase/loop.xml
M reference/event/eventbuffer/appendfrom.xml
M reference/event/eventbuffer/read.xml
M reference/event/eventbufferevent.about.callbacks.xml
M reference/event/eventbufferevent/createpair.xml
M reference/event/eventbufferevent/sslfilter.xml
M reference/event/eventdnsbase/construct.xml
M reference/event/eventhttp/construct.xml
M reference/event/eventhttp/setcallback.xml
M reference/event/eventhttp/setdefaultcallback.xml
M reference/event/eventhttpconnection/construct.xml
M reference/event/eventlistener/construct.xml
M reference/event/eventlistener/setcallback.xml
M reference/event/eventlistener/seterrorcallback.xml
Diff:
diff --git a/reference/event/event.callbacks.xml b/reference/event/event.callbacks.xml
index 16634fe4cc19..c5017d8aeb4d 100644
--- a/reference/event/event.callbacks.xml
+++ b/reference/event/event.callbacks.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<chapter xml:id="event.callbacks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="event.callbacks">
<title>Event callbacks</title>
<para>
If a callback is registered for an event, it will be called when the event
@@ -19,63 +19,58 @@
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>fd</parameter>
<initializer>&null;</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>int</type>
<parameter>what</parameter>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>fd</parameter>
+ </term>
+ <listitem>
+ <para>
+ The file descriptor, stream resource or socket associated with the
+ event. For signal event
<parameter>fd</parameter>
- </term>
- <listitem>
- <para>
- The file descriptor, stream resource or socket associated with the
- event. For signal event
- <parameter>fd</parameter>
- is equal to the signal number.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>what</parameter>
- </term>
- <listitem>
- <para>
- Bit mask of
- <emphasis>all</emphasis>
- events triggered.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>arg</parameter>
- </term>
- <listitem>
- <para>
- User custom data.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ is equal to the signal number.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>what</parameter>
+ </term>
+ <listitem>
+ <para>
+ Bit mask of
+ <emphasis>all</emphasis>
+ events triggered.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>arg</parameter>
+ </term>
+ <listitem>
+ <para>
+ User custom data.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<para>
<methodname>Event::timer</methodname>
expects the callback to match the following prototype:
@@ -83,27 +78,24 @@
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>arg</parameter>
- </term>
- <listitem>
- <para>
- User custom data.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>arg</parameter>
+ </term>
+ <listitem>
+ <para>
+ User custom data.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<para>
<methodname>Event::signal</methodname>
expects the callback to match the following prototype:
@@ -111,44 +103,40 @@
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>int</type>
<parameter>signum</parameter>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>signum</parameter>
- </term>
- <listitem>
- <para>
- The number of the triggered signal(e.g.
- <constant>SIGTERM</constant>
- ).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>arg</parameter>
- </term>
- <listitem>
- <para>
- User custom data.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>signum</parameter>
+ </term>
+ <listitem>
+ <para>
+ The number of the triggered signal(e.g.
+ <constant>SIGTERM</constant>
+ ).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>arg</parameter>
+ </term>
+ <listitem>
+ <para>
+ User custom data.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/event/eventbase/dispatch.xml b/reference/event/eventbase/dispatch.xml
index 1bdf12924c98..bce4be7b960f 100644
--- a/reference/event/eventbase/dispatch.xml
+++ b/reference/event/eventbase/dispatch.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventbase.dispatch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="eventbase.dispatch">
<refnamediv>
<refname>EventBase::dispatch</refname>
<refpurpose>Dispatch pending events</refpurpose>
@@ -12,19 +11,16 @@
<modifier>public</modifier>
<type>void</type>
<methodname>EventBase::dispatch</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Wait for events to become active, and run their callbacks. The same as
<methodname>EventBase::loop</methodname>
with no flags set.
</para>
- <para>
- <warning>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
- xpointer(id('eventbase.intro')/db:warning/db:para)" />
- </warning>
- </para>
+ <warning>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('eventbase.intro')/db:warning/db:para)"/>
+ </warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
diff --git a/reference/event/eventbase/loop.xml b/reference/event/eventbase/loop.xml
index 9a2f74301c66..99c97aac5958 100644
--- a/reference/event/eventbase/loop.xml
+++ b/reference/event/eventbase/loop.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventbase.loop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="eventbase.loop">
<refnamediv>
<refname>EventBase::loop</refname>
<refpurpose>Dispatch pending events</refpurpose>
@@ -19,12 +19,9 @@
<para>
Wait for events to become active, and run their callbacks.
</para>
- <para>
- <warning>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
- xpointer(id('eventbase.intro')/db:warning/db:para)" />
- </warning>
- </para>
+ <warning>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('eventbase.intro')/db:warning/db:para)"/>
+ </warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
diff --git a/reference/event/eventbuffer/appendfrom.xml b/reference/event/eventbuffer/appendfrom.xml
index 6dcba4d027a6..f3792ee9cc66 100644
--- a/reference/event/eventbuffer/appendfrom.xml
+++ b/reference/event/eventbuffer/appendfrom.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventbuffer.appendfrom" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventbuffer.appendfrom">
<refnamediv>
<refname>EventBuffer::appendFrom</refname>
<refpurpose>Moves the specified number of bytes from a source buffer to the
@@ -45,7 +45,7 @@
<parameter>len</parameter>
</term>
<listitem>
- <para></para>
+ <para/>
</listitem>
</varlistentry>
</variablelist>
@@ -58,27 +58,25 @@
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL event 1.6.0</entry>
- <entry>
- Renamed <methodname>EventBuffer::appendFrom</methodname>(the old
- method name) to <methodname>EventBuffer::appendFrom</methodname>.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL event 1.6.0</entry>
+ <entry>
+ Renamed <methodname>EventBuffer::appendFrom</methodname>(the old
+ method name) to <methodname>EventBuffer::appendFrom</methodname>.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
diff --git a/reference/event/eventbuffer/read.xml b/reference/event/eventbuffer/read.xml
index cdb4ad00fe38..404e79ad82d7 100644
--- a/reference/event/eventbuffer/read.xml
+++ b/reference/event/eventbuffer/read.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventbuffer.read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventbuffer.read">
<refnamediv>
<refname>EventBuffer::read</refname>
<refpurpose>Read data from an evbuffer and drain the bytes read</refpurpose>
@@ -48,30 +48,28 @@
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL event 1.6.0</entry>
- <entry>
- Renamed <methodname>EventBuffer::read</methodname>(the old method
- name) to <methodname>EventBuffer::read</methodname>.
- <methodname>EventBuffer::read</methodname> now takes only
- <parameter>max_bytes</parameter> argument; returns string instead of
- integer.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL event 1.6.0</entry>
+ <entry>
+ Renamed <methodname>EventBuffer::read</methodname>(the old method
+ name) to <methodname>EventBuffer::read</methodname>.
+ <methodname>EventBuffer::read</methodname> now takes only
+ <parameter>max_bytes</parameter> argument; returns string instead of
+ integer.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
diff --git a/reference/event/eventbufferevent.about.callbacks.xml b/reference/event/eventbufferevent.about.callbacks.xml
index d1594fabc103..5ef366d328e0 100644
--- a/reference/event/eventbufferevent.about.callbacks.xml
+++ b/reference/event/eventbufferevent.about.callbacks.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<chapter xml:id="eventbufferevent.about.callbacks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventbufferevent.about.callbacks">
<title>About buffer event callbacks</title>
<para>
An object of
@@ -19,120 +19,111 @@
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>EventBufferEvent</type>
<parameter>bev</parameter>
<initializer>&null;</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>bev</parameter>
- </term>
- <listitem>
- <para>
- Associated
- <classname>EventBufferEvent</classname>
- object.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>arg</parameter>
- </term>
- <listitem>
- <para>
- Custom variable attached to all callbacks via
- <methodname>EventBufferEvent::__construct</methodname>,
- or
- <methodname>EventBufferEvent::setCallbacks</methodname>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>bev</parameter>
+ </term>
+ <listitem>
+ <para>
+ Associated
+ <classname>EventBufferEvent</classname>
+ object.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>arg</parameter>
+ </term>
+ <listitem>
+ <para>
+ Custom variable attached to all callbacks via
+ <methodname>EventBufferEvent::__construct</methodname>,
+ or
+ <methodname>EventBufferEvent::setCallbacks</methodname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<para>
Event callback should match the following prototype:
</para>
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>EventBufferEvent</type>
<parameter>bev</parameter>
<initializer>&null;</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>int</type>
<parameter>events</parameter>
<initializer>0</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>bev</parameter>
- </term>
- <listitem>
- <para>
- Associated
- <classname>EventBufferEvent</classname>
- object.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>events</parameter>
- </term>
- <listitem>
- <para>
- Bit mask of events:
- <constant>EventBufferEvent::READING</constant>,
- <constant>EventBufferEvent::WRITING</constant>,
- <constant>EventBufferEvent::EOL</constant>,
- <constant>EventBufferEvent::ERROR</constant>
- and
- <constant>EventBufferEvent::TIMEOUT</constant>.
- See
- <link linkend="eventbufferevent.constants">EventBufferEvent constants</link>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>arg</parameter>
- </term>
- <listitem>
- <para>
- Custom variable attached to all callbacks via
- <methodname>EventBufferEvent::__construct</methodname>,
- or
- <methodname>EventBufferEvent::setCallbacks</methodname>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>bev</parameter>
+ </term>
+ <listitem>
+ <para>
+ Associated
+ <classname>EventBufferEvent</classname>
+ object.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>events</parameter>
+ </term>
+ <listitem>
+ <para>
+ Bit mask of events:
+ <constant>EventBufferEvent::READING</constant>,
+ <constant>EventBufferEvent::WRITING</constant>,
+ <constant>EventBufferEvent::EOL</constant>,
+ <constant>EventBufferEvent::ERROR</constant>
+ and
+ <constant>EventBufferEvent::TIMEOUT</constant>.
+ See
+ <link linkend="eventbufferevent.constants">EventBufferEvent constants</link>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>arg</parameter>
+ </term>
+ <listitem>
+ <para>
+ Custom variable attached to all callbacks via
+ <methodname>EventBufferEvent::__construct</methodname>,
+ or
+ <methodname>EventBufferEvent::setCallbacks</methodname>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/event/eventbufferevent/createpair.xml b/reference/event/eventbufferevent/createpair.xml
index 4cf6a24bb406..ad625897402f 100644
--- a/reference/event/eventbufferevent/createpair.xml
+++ b/reference/event/eventbufferevent/createpair.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventbufferevent.createpair" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventbufferevent.createpair">
<refnamediv>
<refname>EventBufferEvent::createPair</refname>
<refpurpose>Creates two buffer events connected to each other</refpurpose>
@@ -16,8 +16,7 @@
<type>EventBase</type>
<parameter>base</parameter>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>int</type>
<parameter>options</parameter>
<initializer>0</initializer>
@@ -72,26 +71,24 @@
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL event 1.9.0</entry>
- <entry>
- Method made static.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL event 1.9.0</entry>
+ <entry>
+ Method made static.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/event/eventbufferevent/sslfilter.xml b/reference/event/eventbufferevent/sslfilter.xml
index a556e6f13bf5..c3843ecf416a 100644
--- a/reference/event/eventbufferevent/sslfilter.xml
+++ b/reference/event/eventbufferevent/sslfilter.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventbufferevent.sslfilter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
-xmlns:xi="http://www.w3.org/2001/XInclude">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="eventbufferevent.sslfilter">
<refnamediv>
<refname>EventBufferEvent::sslFilter</refname>
<refpurpose>Create a new SSL buffer event to send its data over another buffer event</refpurpose>
@@ -29,8 +28,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude">
<type>int</type>
<parameter>state</parameter>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>int</type>
<parameter>options</parameter>
<initializer>0</initializer>
@@ -118,12 +116,9 @@ xmlns:xi="http://www.w3.org/2001/XInclude">
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
- xpointer(id('event.example.smtp')/*)" />
- </example>
- </para>
+ <example>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('event.example.smtp')/*)"/>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
diff --git a/reference/event/eventdnsbase/construct.xml b/reference/event/eventdnsbase/construct.xml
index 17d4c6e316d3..fd4bb98fde2f 100644
--- a/reference/event/eventdnsbase/construct.xml
+++ b/reference/event/eventdnsbase/construct.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventdnsbase.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventdnsbase.construct">
<refnamediv>
<refname>EventDnsBase::__construct</refname>
<refpurpose>Constructs EventDnsBase object</refpurpose>
@@ -100,39 +100,37 @@
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL event 3.1.3</entry>
- <entry>
- If <parameter>initialize</parameter> has a type other than
- <type class="union"><type>int</type><type>bool</type></type>,
- a <exceptionname>TypeError</exceptionname> is thrown.
- </entry>
- </row>
- <row>
- <entry>PECL event 3.1.0RC1</entry>
- <entry>
- The type of the <parameter>initialize</parameter> parameter has been changed from <type>bool</type>
- to <type>mixed</type>. The value can be either <type>bool</type> (preserving the previous meaning)
- or one of the following constants:
- <constant>EventDnsBase::DISABLE_WHEN_INACTIVE</constant>,
- <constant>EventDnsBase::INITIALIZE_NAMESERVERS</constant>,
- or <constant>EventDnsBase::NAMESERVERS_NO_DEFAULT</constant>.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL event 3.1.3</entry>
+ <entry>
+ If <parameter>initialize</parameter> has a type other than
+ <type class="union"><type>int</type><type>bool</type></type>,
+ a <exceptionname>TypeError</exceptionname> is thrown.
+ </entry>
+ </row>
+ <row>
+ <entry>PECL event 3.1.0RC1</entry>
+ <entry>
+ The type of the <parameter>initialize</parameter> parameter has been changed from <type>bool</type>
+ to <type>mixed</type>. The value can be either <type>bool</type> (preserving the previous meaning)
+ or one of the following constants:
+ <constant>EventDnsBase::DISABLE_WHEN_INACTIVE</constant>,
+ <constant>EventDnsBase::INITIALIZE_NAMESERVERS</constant>,
+ or <constant>EventDnsBase::NAMESERVERS_NO_DEFAULT</constant>.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/event/eventhttp/construct.xml b/reference/event/eventhttp/construct.xml
index 4ebc9012f2bf..fb6c8d92a065 100644
--- a/reference/event/eventhttp/construct.xml
+++ b/reference/event/eventhttp/construct.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventhttp.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventhttp.construct">
<refnamediv>
<refname>EventHttp::__construct</refname>
<refpurpose>Constructs EventHttp object (the HTTP server)</refpurpose>
@@ -66,26 +66,24 @@
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL event 1.9.0</entry>
- <entry>
- OpenSSL support (<parameter>ctx</parameter>) added.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL event 1.9.0</entry>
+ <entry>
+ OpenSSL support (<parameter>ctx</parameter>) added.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
diff --git a/reference/event/eventhttp/setcallback.xml b/reference/event/eventhttp/setcallback.xml
index 7e69432c6d1f..71626535760c 100644
--- a/reference/event/eventhttp/setcallback.xml
+++ b/reference/event/eventhttp/setcallback.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventhttp.setcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventhttp.setcallback">
<refnamediv>
<refname>EventHttp::setCallback</refname>
<refpurpose>Sets a callback for specified URI</refpurpose>
@@ -56,44 +56,40 @@
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>EventHttpRequest</type>
<parameter>req</parameter>
<initializer>NULL</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>NULL</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>req</parameter>
- </term>
- <listitem>
- <para>
- <classname>EventHttpRequest</classname>
- object.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>arg</parameter>
- </term>
- <listitem>
- <para>
- Custom data.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>req</parameter>
+ </term>
+ <listitem>
+ <para>
+ <classname>EventHttpRequest</classname>
+ object.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>arg</parameter>
+ </term>
+ <listitem>
+ <para>
+ Custom data.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
<varlistentry>
diff --git a/reference/event/eventhttp/setdefaultcallback.xml b/reference/event/eventhttp/setdefaultcallback.xml
index 3b65085a73fe..f6214c3c6e7c 100644
--- a/reference/event/eventhttp/setdefaultcallback.xml
+++ b/reference/event/eventhttp/setdefaultcallback.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventhttp.setdefaultcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventhttp.setdefaultcallback">
<refnamediv>
<refname>EventHttp::setDefaultCallback</refname>
<refpurpose>Sets default callback to handle requests that are not caught by specific callbacks</refpurpose>
@@ -41,44 +41,40 @@
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>EventHttpRequest</type>
<parameter>req</parameter>
<initializer>NULL</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>NULL</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>req</parameter>
- </term>
- <listitem>
- <para>
- <classname>EventHttpRequest</classname>
- object.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>arg</parameter>
- </term>
- <listitem>
- <para>
- Custom data.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>req</parameter>
+ </term>
+ <listitem>
+ <para>
+ <classname>EventHttpRequest</classname>
+ object.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>arg</parameter>
+ </term>
+ <listitem>
+ <para>
+ Custom data.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
<varlistentry>
diff --git a/reference/event/eventhttpconnection/construct.xml b/reference/event/eventhttpconnection/construct.xml
index 9a986e8872b3..c4daf0498dce 100644
--- a/reference/event/eventhttpconnection/construct.xml
+++ b/reference/event/eventhttpconnection/construct.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventhttpconnection.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventhttpconnection.construct">
<refnamediv>
<refname>EventHttpConnection::__construct</refname>
<refpurpose>Constructs EventHttpConnection object</refpurpose>
@@ -106,26 +106,24 @@
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL event 1.9.0</entry>
- <entry>
- OpenSSL support (<parameter>ctx</parameter>) added.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL event 1.9.0</entry>
+ <entry>
+ OpenSSL support (<parameter>ctx</parameter>) added.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/event/eventlistener/construct.xml b/reference/event/eventlistener/construct.xml
index 8e6a859a85aa..af918584b540 100644
--- a/reference/event/eventlistener/construct.xml
+++ b/reference/event/eventlistener/construct.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventlistener.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventlistener.construct">
<refnamediv>
<refname>EventListener::__construct</refname>
<refpurpose>Creates new connection listener associated with an event base</refpurpose>
@@ -129,26 +129,24 @@
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL event 1.5.0</entry>
- <entry>
- UNIX domain sockets' support added.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL event 1.5.0</entry>
+ <entry>
+ UNIX domain sockets' support added.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
@@ -196,7 +194,7 @@ class MyListenerConnection {
public function echoReadCallback($bev, $ctx) {
// Copy all the data from the input buffer to the output buffer
-
+
// Variant #1
$bev->output->addBuffer($bev->input);
diff --git a/reference/event/eventlistener/setcallback.xml b/reference/event/eventlistener/setcallback.xml
index b5974bec0775..f941b9e43a54 100644
--- a/reference/event/eventlistener/setcallback.xml
+++ b/reference/event/eventlistener/setcallback.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventlistener.setcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventlistener.setcallback">
<refnamediv>
<refname>EventListener::setCallback</refname>
<refpurpose>The setCallback purpose</refpurpose>
@@ -15,8 +15,7 @@
<type>callable</type>
<parameter>cb</parameter>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
@@ -44,79 +43,73 @@
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>EventListener</type>
<parameter>listener</parameter>
<initializer>&null;</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>fd</parameter>
<initializer>&null;</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>array</type>
<parameter>address</parameter>
<initializer>&null;</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>arg</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>listener</parameter>
- </term>
- <listitem>
- <para>
- The
- <classname>EventListener</classname>
- object.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>fd</parameter>
- </term>
- <listitem>
- <para>
- The file descriptor or a resource associated with the listener.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>address</parameter>
- </term>
- <listitem>
- <para>
- Array of two elements: IP address and the
- <emphasis>server</emphasis>
- port.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>arg</parameter>
- </term>
- <listitem>
- <para>
- User custom data attached to the callback.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>listener</parameter>
+ </term>
+ <listitem>
+ <para>
+ The
+ <classname>EventListener</classname>
+ object.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>fd</parameter>
+ </term>
+ <listitem>
+ <para>
+ The file descriptor or a resource associated with the listener.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>address</parameter>
+ </term>
+ <listitem>
+ <para>
+ Array of two elements: IP address and the
+ <emphasis>server</emphasis>
+ port.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>arg</parameter>
+ </term>
+ <listitem>
+ <para>
+ User custom data attached to the callback.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
<varlistentry>
diff --git a/reference/event/eventlistener/seterrorcallback.xml b/reference/event/eventlistener/seterrorcallback.xml
index a54bda7b5260..49e728e58708 100644
--- a/reference/event/eventlistener/seterrorcallback.xml
+++ b/reference/event/eventlistener/seterrorcallback.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="eventlistener.seterrorcallback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eventlistener.seterrorcallback">
<refnamediv>
<refname>EventListener::setErrorCallback</refname>
<refpurpose>Set event listener's error callback</refpurpose>
@@ -34,52 +34,48 @@
<methodsynopsis>
<type>void</type>
<methodname>callback</methodname>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>EventListener</type>
<parameter>listener</parameter>
<initializer>&null;</initializer>
</methodparam>
- <methodparam
- choice="opt">
+ <methodparam choice="opt">
<type>mixed</type>
<parameter>data</parameter>
<initializer>&null;</initializer>
</methodparam>
</methodsynopsis>
- <para>
- <variablelist>
- <varlistentry>
- <term>
- <parameter>listener</parameter>
- </term>
- <listitem>
- <para>
- The
- <classname>EventListener</classname>
- object.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>data</parameter>
- </term>
- <listitem>
- <para>
- User custom data attached to the callback.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>listener</parameter>
+ </term>
+ <listitem>
+ <para>
+ The
+ <classname>EventListener</classname>
+ object.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>data</parameter>
+ </term>
+ <listitem>
+ <para>
+ User custom data attached to the callback.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para></para>
+ <para/>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;