didou Tue Feb 6 00:35:15 2007 UTC
Modified files:
/phpdoc/en/reference/wddx/functions wddx-add-vars.xml
wddx-packet-end.xml
wddx-packet-start.xml
wddx-serialize-value.xml
wddx-serialize-vars.xml
wddx-unserialize.xml
Log:
WS, prepare for new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/wddx/functions/wddx-add-vars.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/wddx/functions/wddx-add-vars.xml
diff -u phpdoc/en/reference/wddx/functions/wddx-add-vars.xml:1.3
phpdoc/en/reference/wddx/functions/wddx-add-vars.xml:1.4
--- phpdoc/en/reference/wddx/functions/wddx-add-vars.xml:1.3 Fri Jan 24
22:55:00 2003
+++ phpdoc/en/reference/wddx/functions/wddx-add-vars.xml Tue Feb 6
00:35:14 2007
@@ -1,30 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/wddx.xml, last change in rev 1.2 -->
- <refentry id="function.wddx-add-vars">
- <refnamediv>
- <refname>wddx_add_vars</refname>
- <refpurpose>
- Add variables to a WDDX packet with the specified ID
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>wddx_add_vars</methodname>
-
<methodparam><type>int</type><parameter>packet_id</parameter></methodparam>
-
<methodparam><type>mixed</type><parameter>name_var</parameter></methodparam>
- <methodparam
choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>wddx_add_vars</function> is used to serialize passed
- variables and add the result to the packet specified by the
- <parameter>packet_id</parameter>. The variables to be serialized
- are specified in exactly the same way as
- <function>wddx_serialize_vars</function>.
- </para>
- </refsect1>
- </refentry>
+<refentry id="function.wddx-add-vars">
+ <refnamediv>
+ <refname>wddx_add_vars</refname>
+ <refpurpose>Add variables to a WDDX packet with the specified ID</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <type>bool</type><methodname>wddx_add_vars</methodname>
+ <methodparam><type>int</type><parameter>packet_id</parameter></methodparam>
+ <methodparam><type>mixed</type><parameter>name_var</parameter></methodparam>
+ <methodparam
choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>wddx_add_vars</function> is used to serialize passed
+ variables and add the result to the packet specified by the
+ <parameter>packet_id</parameter>. The variables to be serialized
+ are specified in exactly the same way as
+ <function>wddx_serialize_vars</function>.
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/wddx/functions/wddx-packet-end.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/wddx/functions/wddx-packet-end.xml
diff -u phpdoc/en/reference/wddx/functions/wddx-packet-end.xml:1.3
phpdoc/en/reference/wddx/functions/wddx-packet-end.xml:1.4
--- phpdoc/en/reference/wddx/functions/wddx-packet-end.xml:1.3 Tue Jun 21
23:27:37 2005
+++ phpdoc/en/reference/wddx/functions/wddx-packet-end.xml Tue Feb 6
00:35:15 2007
@@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/wddx.xml, last change in rev 1.2 -->
- <refentry id="function.wddx-packet-end">
- <refnamediv>
- <refname>wddx_packet_end</refname>
- <refpurpose>Ends a WDDX packet with the specified ID</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>wddx_packet_end</methodname>
-
<methodparam><type>resource</type><parameter>packet_id</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>wddx_packet_end</function> ends the WDDX packet
- specified by the <parameter>packet_id</parameter> and returns the
- string with the packet.
- </para>
- </refsect1>
- </refentry>
+<refentry id="function.wddx-packet-end">
+ <refnamediv>
+ <refname>wddx_packet_end</refname>
+ <refpurpose>Ends a WDDX packet with the specified ID</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <type>string</type><methodname>wddx_packet_end</methodname>
+
<methodparam><type>resource</type><parameter>packet_id</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>wddx_packet_end</function> ends the WDDX packet
+ specified by the <parameter>packet_id</parameter> and returns the
+ string with the packet.
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/wddx/functions/wddx-packet-start.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/wddx/functions/wddx-packet-start.xml
diff -u phpdoc/en/reference/wddx/functions/wddx-packet-start.xml:1.3
phpdoc/en/reference/wddx/functions/wddx-packet-start.xml:1.4
--- phpdoc/en/reference/wddx/functions/wddx-packet-start.xml:1.3 Tue Jun
21 23:27:37 2005
+++ phpdoc/en/reference/wddx/functions/wddx-packet-start.xml Tue Feb 6
00:35:15 2007
@@ -1,28 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/wddx.xml, last change in rev 1.2 -->
- <refentry id="function.wddx-packet-start">
- <refnamediv>
- <refname>wddx_packet_start</refname>
- <refpurpose>
- Starts a new WDDX packet with structure inside it
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>resource</type><methodname>wddx_packet_start</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>comment</parameter></methodparam>
- </methodsynopsis>
- <para>
- Use <function>wddx_packet_start</function> to start a new WDDX
- packet for incremental addition of variables. It takes an
- optional <parameter>comment</parameter> string and returns a
- packet ID for use in later functions. It automatically creates a
- structure definition inside the packet to contain the variables.
- </para>
- </refsect1>
- </refentry>
+<refentry id="function.wddx-packet-start">
+ <refnamediv>
+ <refname>wddx_packet_start</refname>
+ <refpurpose>Starts a new WDDX packet with structure inside it</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <type>resource</type><methodname>wddx_packet_start</methodname>
+ <methodparam
choice="opt"><type>string</type><parameter>comment</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Use <function>wddx_packet_start</function> to start a new WDDX
+ packet for incremental addition of variables. It takes an
+ optional <parameter>comment</parameter> string and returns a
+ packet ID for use in later functions. It automatically creates a
+ structure definition inside the packet to contain the variables.
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/wddx/functions/wddx-serialize-value.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/wddx/functions/wddx-serialize-value.xml
diff -u phpdoc/en/reference/wddx/functions/wddx-serialize-value.xml:1.2
phpdoc/en/reference/wddx/functions/wddx-serialize-value.xml:1.3
--- phpdoc/en/reference/wddx/functions/wddx-serialize-value.xml:1.2 Wed Apr
17 06:45:09 2002
+++ phpdoc/en/reference/wddx/functions/wddx-serialize-value.xml Tue Feb 6
00:35:15 2007
@@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/wddx.xml, last change in rev 1.2 -->
- <refentry id="function.wddx-serialize-value">
- <refnamediv>
- <refname>wddx_serialize_value</refname>
- <refpurpose>Serialize a single value into a WDDX packet</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>wddx_serialize_value</methodname>
- <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>comment</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>wddx_serialize_value</function> is used to create a
- WDDX packet from a single given value. It takes the value
- contained in <parameter>var</parameter>, and an optional
- <parameter>comment</parameter> string that appears in the packet
- header, and returns the WDDX packet.
- </para>
- </refsect1>
- </refentry>
+<refentry id="function.wddx-serialize-value">
+ <refnamediv>
+ <refname>wddx_serialize_value</refname>
+ <refpurpose>Serialize a single value into a WDDX packet</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <type>string</type><methodname>wddx_serialize_value</methodname>
+ <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>comment</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>wddx_serialize_value</function> is used to create a
+ WDDX packet from a single given value. It takes the value
+ contained in <parameter>var</parameter>, and an optional
+ <parameter>comment</parameter> string that appears in the packet
+ header, and returns the WDDX packet.
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/wddx/functions/wddx-serialize-vars.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/wddx/functions/wddx-serialize-vars.xml
diff -u phpdoc/en/reference/wddx/functions/wddx-serialize-vars.xml:1.4
phpdoc/en/reference/wddx/functions/wddx-serialize-vars.xml:1.5
--- phpdoc/en/reference/wddx/functions/wddx-serialize-vars.xml:1.4 Mon Dec
15 16:55:22 2003
+++ phpdoc/en/reference/wddx/functions/wddx-serialize-vars.xml Tue Feb 6
00:35:15 2007
@@ -1,33 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/wddx.xml, last change in rev 1.2 -->
- <refentry id="function.wddx-serialize-vars">
- <refnamediv>
- <refname>wddx_serialize_vars</refname>
- <refpurpose>Serialize variables into a WDDX packet</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>wddx_serialize_vars</methodname>
-
<methodparam><type>mixed</type><parameter>var_name</parameter></methodparam>
- <methodparam
choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>wddx_serialize_vars</function> is used to create a WDDX
- packet with a structure that contains the serialized
- representation of the passed variables.
- </para>
- <para>
- <function>wddx_serialize_vars</function> takes a variable number
- of arguments, each of which can be either a string naming a
- variable or an array containing strings naming the variables or
- another array, etc.
- </para>
- <para>
- <example>
- <title><function>wddx_serialize_vars</function> example</title>
- <programlisting role="php">
+<refentry id="function.wddx-serialize-vars">
+ <refnamediv>
+ <refname>wddx_serialize_vars</refname>
+ <refpurpose>Serialize variables into a WDDX packet</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <type>string</type><methodname>wddx_serialize_vars</methodname>
+ <methodparam><type>mixed</type><parameter>var_name</parameter></methodparam>
+ <methodparam
choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>wddx_serialize_vars</function> is used to create a WDDX
+ packet with a structure that contains the serialized
+ representation of the passed variables.
+ </para>
+ <para>
+ <function>wddx_serialize_vars</function> takes a variable number
+ of arguments, each of which can be either a string naming a
+ variable or an array containing strings naming the variables or
+ another array, etc.
+ </para>
+ <para>
+ <example>
+ <title><function>wddx_serialize_vars</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$a = 1;
@@ -39,22 +39,22 @@
echo wddx_serialize_vars("a", "b", $clvars);
?>
]]>
- </programlisting>
- </example>
- </para>
- <para>
- The above example will produce:
- <screen>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ The above example will produce:
+ <screen>
<![CDATA[
<wddxPacket version='1.0'><header/><data><struct><var
name='a'><number>1</number></var>
<var name='b'><number>5.5</number></var><var name='c'><array length='3'>
<string>blue</string><string>orange</string><string>violet</string></array></var>
<var name='d'><string>colors</string></var></struct></data></wddxPacket>
]]>
- </screen>
- </para>
- </refsect1>
- </refentry>
+ </screen>
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/wddx/functions/wddx-unserialize.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/wddx/functions/wddx-unserialize.xml
diff -u phpdoc/en/reference/wddx/functions/wddx-unserialize.xml:1.1
phpdoc/en/reference/wddx/functions/wddx-unserialize.xml:1.2
--- phpdoc/en/reference/wddx/functions/wddx-unserialize.xml:1.1 Sun Aug 14
16:10:42 2005
+++ phpdoc/en/reference/wddx/functions/wddx-unserialize.xml Tue Feb 6
00:35:15 2007
@@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/wddx.xml, last change in rev 1.2 -->
- <refentry id="function.wddx-unserialize">
- <refnamediv>
- <refname>wddx_unserialize</refname>
- <refpurpose>Unserializes a WDDX packet</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>mixed</type><methodname>wddx_unserialize</methodname>
-
<methodparam><type>string</type><parameter>packet</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>wddx_unserialize</function> takes a
- <parameter>packet</parameter> string and unserializes it. It
- returns the result which can be string, number, or array. Note
- that structures are unserialized into associative arrays.
- </para>
- </refsect1>
- </refentry>
+<refentry id="function.wddx-unserialize">
+ <refnamediv>
+ <refname>wddx_unserialize</refname>
+ <refpurpose>Unserializes a WDDX packet</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <type>mixed</type><methodname>wddx_unserialize</methodname>
+ <methodparam><type>string</type><parameter>packet</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>wddx_unserialize</function> takes a
+ <parameter>packet</parameter> string and unserializes it. It
+ returns the result which can be string, number, or array. Note
+ that structures are unserialized into associative arrays.
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
