cvs: phpdoc /en/reference/array/functions array-product.xml array-values.xml end.xml key.xml shuffle.xml /en/reference/hw/functions
hw-array2objrec.xml hw-changeobject.xml hw-close.xml hw-connect.xml hw-connection-info.xml hw-docbyanchorobj.xml hw-dummy.xml hw-error.xml
hw-errormsg.xml hw-getanchors.xml hw-getrellink.xml hw-getusername.xml hw-info.xml hw-output-document.xml hw-setlinkroot.xml hw-stat.xml hw-unlock.xml
/en/reference/strings/functions htmlspecialchars.xml
| From: | Mehdi Achour | Date: | Sat, 29 Dec 2007 23:04:24 +0000 |
| Subject: | cvs: phpdoc /en/reference/array/functions array-product.xml array-values.xml end.xml key.xml shuffle.xml /en/reference/hw/functions hw-array2objrec.xml hw-changeobject.xml hw-close.xml hw-connect.xml hw-connection-info.xml hw-docbyanchorobj.xml hw-dummy.xml hw-error.xml hw-errormsg.xml hw-getanchors.xml hw-getrellink.xml hw-getusername.xml hw-info.xml hw-output-document.xml hw-setlinkroot.xml hw-stat.xml hw-unlock.xml /en/reference/strings/functions htmlspecialchars.xml |
||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-917@lists.php.net to get a copy of this message | ||
didou Sat Dec 29 23:04:24 2007 UTC
Modified files:
/phpdoc/en/reference/array/functions array-product.xml
array-values.xml end.xml
key.xml shuffle.xml
/phpdoc/en/reference/hw/functions hw-array2objrec.xml
hw-changeobject.xml hw-close.xml
hw-connect.xml
hw-connection-info.xml
hw-docbyanchorobj.xml
hw-dummy.xml hw-error.xml
hw-errormsg.xml hw-getanchors.xml
hw-getrellink.xml
hw-getusername.xml hw-info.xml
hw-output-document.xml
hw-setlinkroot.xml hw-stat.xml
hw-unlock.xml
/phpdoc/en/reference/strings/functions htmlspecialchars.xml
Log:
Switch to new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/array-product.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/array/functions/array-product.xml diff -u phpdoc/en/reference/array/functions/array-product.xml:1.3 phpdoc/en/reference/array/functions/array-product.xml:1.4 --- phpdoc/en/reference/array/functions/array-product.xml:1.3 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/array-product.xml Sat Dec 29 23:04:24 2007 @@ -1,20 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.array-product" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>array_product</refname> <refpurpose>Calculate the product of values in an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>number</type><methodname>array_product</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> </methodsynopsis> <para> <function>array_product</function> returns the product of values - in an array as an integer or float. + in an array. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the product as an integer or float. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>array_product</function> examples</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/array-values.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/array/functions/array-values.xml diff -u phpdoc/en/reference/array/functions/array-values.xml:1.12 phpdoc/en/reference/array/functions/array-values.xml:1.13 --- phpdoc/en/reference/array/functions/array-values.xml:1.12 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/array-values.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> -<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 --> +<!-- $Revision: 1.13 $ --> <refentry xml:id="function.array-values" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>array_values</refname> <refpurpose>Return all the values of an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>array_values</methodname> <methodparam><type>array</type><parameter>input</parameter></methodparam> @@ -17,6 +16,30 @@ <parameter>input</parameter> array and indexes numerically the array. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>input</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an indexed array of values. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>array_values</function> example</title> @@ -40,8 +63,13 @@ </screen> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>array_keys</function>. + <simplelist> + <member><function>array_keys</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/end.xml?r1=1.14&r2=1.15&diff_format=u Index: phpdoc/en/reference/array/functions/end.xml diff -u phpdoc/en/reference/array/functions/end.xml:1.14 phpdoc/en/reference/array/functions/end.xml:1.15 --- phpdoc/en/reference/array/functions/end.xml:1.14 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/end.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 --> <refentry xml:id="function.end" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>end</refname> <refpurpose>Set the internal pointer of an array to its last element</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>end</methodname> <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam> @@ -16,9 +16,33 @@ <function>end</function> advances <parameter>array</parameter>'s internal pointer to the last element, and returns its value. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the value of the last element. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> - <title>A simple <function>end</function> example</title> + <title><function>end</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -31,12 +55,17 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>current</function>, - <function>each</function>, - <function>prev</function>, - <function>next</function> and - <function>reset</function>. + <simplelist> + <member><function>current</function></member> + <member><function>each</function></member> + <member><function>prev</function></member> + <member><function>reset</function></member> + <member><function>next</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/key.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/array/functions/key.xml diff -u phpdoc/en/reference/array/functions/key.xml:1.11 phpdoc/en/reference/array/functions/key.xml:1.12 --- phpdoc/en/reference/array/functions/key.xml:1.11 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/key.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 --> <refentry xml:id="function.key" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>key</refname> <refpurpose>Fetch a key from an associative array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>key</methodname> <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam> </methodsynopsis> <para> - <function>key</function> returns the index element of the - current array position. + <function>key</function> returns the index element of the current array + position. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the index. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>key</function> example</title> @@ -42,8 +66,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>current</function> and <function>next</function>. + <simplelist> + <member><function>current</function></member> + <member><function>next</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/shuffle.xml?r1=1.16&r2=1.17&diff_format=u Index: phpdoc/en/reference/array/functions/shuffle.xml diff -u phpdoc/en/reference/array/functions/shuffle.xml:1.16 phpdoc/en/reference/array/functions/shuffle.xml:1.17 --- phpdoc/en/reference/array/functions/shuffle.xml:1.16 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/shuffle.xml Sat Dec 29 23:04:24 2007 @@ -1,22 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> -<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 --> +<!-- $Revision: 1.17 $ --> <refentry xml:id="function.shuffle" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>shuffle</refname> <refpurpose>Shuffle an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>shuffle</methodname> <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam> </methodsynopsis> <para> - This function shuffles (randomizes the order of the elements in) - an array. + This function shuffles (randomizes the order of the elements in) an array. </para> - ¬e.no-key-association; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>shuffle</function> example</title> @@ -34,13 +55,23 @@ </programlisting> </example> </para> - + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + ¬e.no-key-association; ¬e.randomseed; - + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>arsort</function>, <function>asort</function>, - <function>ksort</function>, <function>rsort</function>, - <function>sort</function>, and <function>usort</function>. + <simplelist> + <member><function>arsort</function></member> + <member><function>asort</function></member> + <member><function>ksort</function></member> + <member><function>rsort</function></member> + <member><function>sort</function></member> + <member><function>usort</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-array2objrec.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-array2objrec.xml diff -u phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.6 phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-array2objrec.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-array2objrec" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Array2Objrec</refname> <refpurpose>Convert attributes from object array to object record</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_array2objrec</methodname> <methodparam><type>array</type><parameter>object_array</parameter></methodparam> @@ -17,8 +16,34 @@ Multiple attributes like 'Title' in different languages are treated properly. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>object_array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object record. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_objrec2array</function>. + <simplelist> + <member><function>hw_objrec2array</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-changeobject.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-changeobject.xml diff -u phpdoc/en/reference/hw/functions/hw-changeobject.xml:1.5 phpdoc/en/reference/hw/functions/hw-changeobject.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-changeobject.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-changeobject.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id='function.hw-changeobject' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_changeobject</refname> <refpurpose>Changes attributes of an object (obsolete)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_changeobject</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-close.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-close.xml diff -u phpdoc/en/reference/hw/functions/hw-close.xml:1.6 phpdoc/en/reference/hw/functions/hw-close.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-close.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-close.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-close" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Close</refname> <refpurpose>Closes the Hyperwave connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_close</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns &false; if connection is not a valid connection index, - otherwise &true;. Closes down the connection to a Hyperwave server - with the given connection index. + Closes down the connection to a Hyperwave server. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-connect.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-connect.xml diff -u phpdoc/en/reference/hw/functions/hw-connect.xml:1.6 phpdoc/en/reference/hw/functions/hw-connect.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-connect.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-connect.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-connect" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Connect</refname> <refpurpose>Opens a connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_connect</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> @@ -16,20 +15,64 @@ <methodparam><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> <para> - Opens a connection to a Hyperwave server and returns a connection - index on success, or &false; if the connection - could not be made. Each of the arguments should be a quoted string, - except for the port number. The <parameter>username</parameter> and - <parameter>password</parameter> arguments are - optional and can be left out. In such a case no identification with - the server will be done. It is similar to identify as user anonymous. - This function returns a connection - index that is needed by other Hyperwave functions. You can have - multiple connections open at once. Keep in mind, that the password - is not encrypted. + Opens a connection to a Hyperwave server. + You can have multiple connections open at once. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>host</parameter></term> + <listitem> + <para> + The server host name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + The server port number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The Hyperwave user name. If ommited, no identification with the server + will be done. It is similar to identify as user anonymous. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password for <parameter>username</parameter>. + Keep in mind, that the password is not encrypted. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a connection index on success, or &false; if the connection could + not be made. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_pconnect</function>. + <simplelist> + <member><function>hw_pconnect</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-connection-info.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-connection-info.xml diff -u phpdoc/en/reference/hw/functions/hw-connection-info.xml:1.4 phpdoc/en/reference/hw/functions/hw-connection-info.xml:1.5 --- phpdoc/en/reference/hw/functions/hw-connection-info.xml:1.4 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-connection-info.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id='function.hw-connection-info' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_connection_info</refname> <refpurpose>Prints information about the connection to Hyperwave server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>hw_connection_info</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml diff -u phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml:1.5 phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-docbyanchorobj" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_DocByAnchorObj</refname> <refpurpose>Object record object belonging to anchor</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_docbyanchorobj</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> <methodparam><type>int</type><parameter>anchorID</parameter></methodparam> </methodsynopsis> <para> - Returns an th object record of the document to - which <parameter>anchorID</parameter> belongs. + Returns an th object record of the document to which + <parameter>anchorID</parameter> belongs. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>anchorID</parameter></term> + <listitem> + <para> + The anchor identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object record. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-dummy.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-dummy.xml diff -u phpdoc/en/reference/hw/functions/hw-dummy.xml:1.4 phpdoc/en/reference/hw/functions/hw-dummy.xml:1.5 --- phpdoc/en/reference/hw/functions/hw-dummy.xml:1.4 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-dummy.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id='function.hw-dummy' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_dummy</refname> <refpurpose>Hyperwave dummy function</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_dummy</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-error.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-error.xml diff -u phpdoc/en/reference/hw/functions/hw-error.xml:1.5 phpdoc/en/reference/hw/functions/hw-error.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-error.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-error.xml Sat Dec 29 23:04:24 2007 @@ -1,20 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-error" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Error</refname> <refpurpose>Error number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_error</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns the last error number. If the return value is 0 no error has - occurred. The error relates to the last command. + Returns the last error number, for the last command. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the last error number or 0 if no error occured. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>hw_errormsg</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-errormsg.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-errormsg.xml diff -u phpdoc/en/reference/hw/functions/hw-errormsg.xml:1.5 phpdoc/en/reference/hw/functions/hw-errormsg.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-errormsg.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-errormsg.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-errormsg" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_ErrorMsg</refname> <refpurpose>Returns error message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_errormsg</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns a string containing the last error message or 'No Error'. If &false; - is returned, this function failed. - The message relates to the last command. + Returns a string containing the last error message related to the last + command. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string containing the last error message or 'No Error'. + If &false; is returned, this function failed. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>hw_error</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-getanchors.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-getanchors.xml diff -u phpdoc/en/reference/hw/functions/hw-getanchors.xml:1.5 phpdoc/en/reference/hw/functions/hw-getanchors.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-getanchors.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-getanchors.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-getanchors" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_GetAnchors</refname> <refpurpose>Object ids of anchors of document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>hw_getanchors</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> <methodparam><type>int</type><parameter>objectID</parameter></methodparam> </methodsynopsis> <para> - Returns an array of object ids with anchors of the document - with object ID <parameter>objectID</parameter>. + Returns an array of object ids with anchors of the specified document. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>objectID</parameter></term> + <listitem> + <para> + The document object id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of object ids. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-getrellink.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-getrellink.xml diff -u phpdoc/en/reference/hw/functions/hw-getrellink.xml:1.4 phpdoc/en/reference/hw/functions/hw-getrellink.xml:1.5 --- phpdoc/en/reference/hw/functions/hw-getrellink.xml:1.4 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-getrellink.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id='function.hw-getrellink' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_getrellink</refname> <refpurpose>Get link from source to dest relative to rootid</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_getrellink</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-getusername.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-getusername.xml diff -u phpdoc/en/reference/hw/functions/hw-getusername.xml:1.5 phpdoc/en/reference/hw/functions/hw-getusername.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-getusername.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-getusername.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-getusername" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_getusername</refname> <refpurpose>Name of currently logged in user</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_getusername</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -16,6 +15,27 @@ Returns the username of the connection. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the username as a string. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-info.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-info.xml diff -u phpdoc/en/reference/hw/functions/hw-info.xml:1.5 phpdoc/en/reference/hw/functions/hw-info.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-info.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-info.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-info" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Info</refname> <refpurpose>Info about connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_info</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns information about the current connection. The returned string - has the following format: <Serverstring>, <Host>, - <Port>, <Username>, <Port of Client>, + Returns information about the current connection. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The returned string has the following format: <Serverstring>, + <Host>, <Port>, <Username>, <Port of Client>, <Byte swapping> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-output-document.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-output-document.xml diff -u phpdoc/en/reference/hw/functions/hw-output-document.xml:1.6 phpdoc/en/reference/hw/functions/hw-output-document.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-output-document.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-output-document.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-output-document" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Output_Document</refname> <refpurpose>Prints hw_document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_output_document</methodname> <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> @@ -20,6 +19,27 @@ also accepted. This is deprecated, however. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hw_document</parameter></term> + <listitem> + <para> + The document identifier. + </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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-setlinkroot.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-setlinkroot.xml diff -u phpdoc/en/reference/hw/functions/hw-setlinkroot.xml:1.5 phpdoc/en/reference/hw/functions/hw-setlinkroot.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-setlinkroot.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-setlinkroot.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id='function.hw-setlinkroot' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_setlinkroot</refname> <refpurpose>Set the id to which links are calculated</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_setlinkroot</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-stat.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-stat.xml diff -u phpdoc/en/reference/hw/functions/hw-stat.xml:1.4 phpdoc/en/reference/hw/functions/hw-stat.xml:1.5 --- phpdoc/en/reference/hw/functions/hw-stat.xml:1.4 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-stat.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id='function.hw-stat' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_stat</refname> <refpurpose>Returns status string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_stat</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-unlock.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-unlock.xml diff -u phpdoc/en/reference/hw/functions/hw-unlock.xml:1.6 phpdoc/en/reference/hw/functions/hw-unlock.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-unlock.xml:1.6 Sat Dec 29 22:27:08 2007 +++ phpdoc/en/reference/hw/functions/hw-unlock.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-unlock" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Unlock</refname> <refpurpose>Unlock object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_unlock</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -16,8 +15,42 @@ <para> Unlocks a document, so other users regain access. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>objectID</parameter></term> + <listitem> + <para> + The document object identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_getandlock</function>. + <simplelist> + <member><function>hw_getandlock</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/strings/functions/htmlspecialchars.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/strings/functions/htmlspecialchars.xml diff -u phpdoc/en/reference/strings/functions/htmlspecialchars.xml:1.11 phpdoc/en/reference/strings/functions/htmlspecialchars.xml:1.12 --- phpdoc/en/reference/strings/functions/htmlspecialchars.xml:1.11 Fri Dec 7 01:18:14 2007 +++ phpdoc/en/reference/strings/functions/htmlspecialchars.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.htmlspecialchars" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>htmlspecialchars</refname> <refpurpose>Convert special characters to HTML entities</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>htmlspecialchars</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> @@ -27,7 +27,7 @@ <simpara> This function is useful in preventing user-supplied text from containing HTML markup, such as in a message board or guest book - application. + application. </simpara> <para> The translations performed are: @@ -93,7 +93,7 @@ <term><parameter>charset</parameter></term> <listitem> <para> - Defines character set used in conversion. + Defines character set used in conversion. The default character set is ISO-8859-1. </para> &reference.strings.charsets; @@ -111,7 +111,7 @@ </variablelist> </para> </refsect1> - + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -182,7 +182,7 @@ </para> </note> </refsect1> - + <refsect1 role="seealso"> &reftitle.seealso; <para>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/array-product.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/array/functions/array-product.xml diff -u phpdoc/en/reference/array/functions/array-product.xml:1.3 phpdoc/en/reference/array/functions/array-product.xml:1.4 --- phpdoc/en/reference/array/functions/array-product.xml:1.3 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/array-product.xml Sat Dec 29 23:04:24 2007 @@ -1,20 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry xml:id="function.array-product" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>array_product</refname> <refpurpose>Calculate the product of values in an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>number</type><methodname>array_product</methodname> <methodparam><type>array</type><parameter>array</parameter></methodparam> </methodsynopsis> <para> <function>array_product</function> returns the product of values - in an array as an integer or float. + in an array. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the product as an integer or float. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>array_product</function> examples</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/array-values.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/array/functions/array-values.xml diff -u phpdoc/en/reference/array/functions/array-values.xml:1.12 phpdoc/en/reference/array/functions/array-values.xml:1.13 --- phpdoc/en/reference/array/functions/array-values.xml:1.12 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/array-values.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> -<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 --> +<!-- $Revision: 1.13 $ --> <refentry xml:id="function.array-values" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>array_values</refname> <refpurpose>Return all the values of an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>array_values</methodname> <methodparam><type>array</type><parameter>input</parameter></methodparam> @@ -17,6 +16,30 @@ <parameter>input</parameter> array and indexes numerically the array. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>input</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an indexed array of values. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>array_values</function> example</title> @@ -40,8 +63,13 @@ </screen> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>array_keys</function>. + <simplelist> + <member><function>array_keys</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/end.xml?r1=1.14&r2=1.15&diff_format=u Index: phpdoc/en/reference/array/functions/end.xml diff -u phpdoc/en/reference/array/functions/end.xml:1.14 phpdoc/en/reference/array/functions/end.xml:1.15 --- phpdoc/en/reference/array/functions/end.xml:1.14 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/end.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 --> <refentry xml:id="function.end" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>end</refname> <refpurpose>Set the internal pointer of an array to its last element</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>end</methodname> <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam> @@ -16,9 +16,33 @@ <function>end</function> advances <parameter>array</parameter>'s internal pointer to the last element, and returns its value. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the value of the last element. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> - <title>A simple <function>end</function> example</title> + <title><function>end</function> example</title> <programlisting role="php"> <![CDATA[ <?php @@ -31,12 +55,17 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>current</function>, - <function>each</function>, - <function>prev</function>, - <function>next</function> and - <function>reset</function>. + <simplelist> + <member><function>current</function></member> + <member><function>each</function></member> + <member><function>prev</function></member> + <member><function>reset</function></member> + <member><function>next</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/key.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/array/functions/key.xml diff -u phpdoc/en/reference/array/functions/key.xml:1.11 phpdoc/en/reference/array/functions/key.xml:1.12 --- phpdoc/en/reference/array/functions/key.xml:1.11 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/key.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 --> <refentry xml:id="function.key" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>key</refname> <refpurpose>Fetch a key from an associative array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>key</methodname> <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam> </methodsynopsis> <para> - <function>key</function> returns the index element of the - current array position. + <function>key</function> returns the index element of the current array + position. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the index. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>key</function> example</title> @@ -42,8 +66,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>current</function> and <function>next</function>. + <simplelist> + <member><function>current</function></member> + <member><function>next</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/shuffle.xml?r1=1.16&r2=1.17&diff_format=u Index: phpdoc/en/reference/array/functions/shuffle.xml diff -u phpdoc/en/reference/array/functions/shuffle.xml:1.16 phpdoc/en/reference/array/functions/shuffle.xml:1.17 --- phpdoc/en/reference/array/functions/shuffle.xml:1.16 Wed Jun 20 22:24:15 2007 +++ phpdoc/en/reference/array/functions/shuffle.xml Sat Dec 29 23:04:24 2007 @@ -1,22 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.16 $ --> -<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 --> +<!-- $Revision: 1.17 $ --> <refentry xml:id="function.shuffle" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>shuffle</refname> <refpurpose>Shuffle an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>shuffle</methodname> <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam> </methodsynopsis> <para> - This function shuffles (randomizes the order of the elements in) - an array. + This function shuffles (randomizes the order of the elements in) an array. </para> - ¬e.no-key-association; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>shuffle</function> example</title> @@ -34,13 +55,23 @@ </programlisting> </example> </para> - + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + ¬e.no-key-association; ¬e.randomseed; - + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>arsort</function>, <function>asort</function>, - <function>ksort</function>, <function>rsort</function>, - <function>sort</function>, and <function>usort</function>. + <simplelist> + <member><function>arsort</function></member> + <member><function>asort</function></member> + <member><function>ksort</function></member> + <member><function>rsort</function></member> + <member><function>sort</function></member> + <member><function>usort</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-array2objrec.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-array2objrec.xml diff -u phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.6 phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-array2objrec.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-array2objrec.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-array2objrec" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Array2Objrec</refname> <refpurpose>Convert attributes from object array to object record</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_array2objrec</methodname> <methodparam><type>array</type><parameter>object_array</parameter></methodparam> @@ -17,8 +16,34 @@ Multiple attributes like 'Title' in different languages are treated properly. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>object_array</parameter></term> + <listitem> + <para> + The array. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object record. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_objrec2array</function>. + <simplelist> + <member><function>hw_objrec2array</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-changeobject.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-changeobject.xml diff -u phpdoc/en/reference/hw/functions/hw-changeobject.xml:1.5 phpdoc/en/reference/hw/functions/hw-changeobject.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-changeobject.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-changeobject.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id='function.hw-changeobject' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_changeobject</refname> <refpurpose>Changes attributes of an object (obsolete)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_changeobject</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-close.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-close.xml diff -u phpdoc/en/reference/hw/functions/hw-close.xml:1.6 phpdoc/en/reference/hw/functions/hw-close.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-close.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-close.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-close" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Close</refname> <refpurpose>Closes the Hyperwave connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_close</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns &false; if connection is not a valid connection index, - otherwise &true;. Closes down the connection to a Hyperwave server - with the given connection index. + Closes down the connection to a Hyperwave server. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-connect.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-connect.xml diff -u phpdoc/en/reference/hw/functions/hw-connect.xml:1.6 phpdoc/en/reference/hw/functions/hw-connect.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-connect.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-connect.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-connect" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Connect</refname> <refpurpose>Opens a connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_connect</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> @@ -16,20 +15,64 @@ <methodparam><type>string</type><parameter>password</parameter></methodparam> </methodsynopsis> <para> - Opens a connection to a Hyperwave server and returns a connection - index on success, or &false; if the connection - could not be made. Each of the arguments should be a quoted string, - except for the port number. The <parameter>username</parameter> and - <parameter>password</parameter> arguments are - optional and can be left out. In such a case no identification with - the server will be done. It is similar to identify as user anonymous. - This function returns a connection - index that is needed by other Hyperwave functions. You can have - multiple connections open at once. Keep in mind, that the password - is not encrypted. + Opens a connection to a Hyperwave server. + You can have multiple connections open at once. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>host</parameter></term> + <listitem> + <para> + The server host name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + The server port number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The Hyperwave user name. If ommited, no identification with the server + will be done. It is similar to identify as user anonymous. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password for <parameter>username</parameter>. + Keep in mind, that the password is not encrypted. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a connection index on success, or &false; if the connection could + not be made. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_pconnect</function>. + <simplelist> + <member><function>hw_pconnect</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-connection-info.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-connection-info.xml diff -u phpdoc/en/reference/hw/functions/hw-connection-info.xml:1.4 phpdoc/en/reference/hw/functions/hw-connection-info.xml:1.5 --- phpdoc/en/reference/hw/functions/hw-connection-info.xml:1.4 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-connection-info.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id='function.hw-connection-info' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_connection_info</refname> <refpurpose>Prints information about the connection to Hyperwave server</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>hw_connection_info</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml diff -u phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml:1.5 phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-docbyanchorobj.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-docbyanchorobj" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_DocByAnchorObj</refname> <refpurpose>Object record object belonging to anchor</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_docbyanchorobj</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> <methodparam><type>int</type><parameter>anchorID</parameter></methodparam> </methodsynopsis> <para> - Returns an th object record of the document to - which <parameter>anchorID</parameter> belongs. + Returns an th object record of the document to which + <parameter>anchorID</parameter> belongs. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>anchorID</parameter></term> + <listitem> + <para> + The anchor identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object record. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-dummy.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-dummy.xml diff -u phpdoc/en/reference/hw/functions/hw-dummy.xml:1.4 phpdoc/en/reference/hw/functions/hw-dummy.xml:1.5 --- phpdoc/en/reference/hw/functions/hw-dummy.xml:1.4 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-dummy.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id='function.hw-dummy' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_dummy</refname> <refpurpose>Hyperwave dummy function</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_dummy</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-error.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-error.xml diff -u phpdoc/en/reference/hw/functions/hw-error.xml:1.5 phpdoc/en/reference/hw/functions/hw-error.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-error.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-error.xml Sat Dec 29 23:04:24 2007 @@ -1,20 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-error" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Error</refname> <refpurpose>Error number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_error</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns the last error number. If the return value is 0 no error has - occurred. The error relates to the last command. + Returns the last error number, for the last command. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the last error number or 0 if no error occured. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>hw_errormsg</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-errormsg.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-errormsg.xml diff -u phpdoc/en/reference/hw/functions/hw-errormsg.xml:1.5 phpdoc/en/reference/hw/functions/hw-errormsg.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-errormsg.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-errormsg.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-errormsg" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_ErrorMsg</refname> <refpurpose>Returns error message</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_errormsg</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns a string containing the last error message or 'No Error'. If &false; - is returned, this function failed. - The message relates to the last command. + Returns a string containing the last error message related to the last + command. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string containing the last error message or 'No Error'. + If &false; is returned, this function failed. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>hw_error</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-getanchors.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-getanchors.xml diff -u phpdoc/en/reference/hw/functions/hw-getanchors.xml:1.5 phpdoc/en/reference/hw/functions/hw-getanchors.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-getanchors.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-getanchors.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-getanchors" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_GetAnchors</refname> <refpurpose>Object ids of anchors of document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>hw_getanchors</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> <methodparam><type>int</type><parameter>objectID</parameter></methodparam> </methodsynopsis> <para> - Returns an array of object ids with anchors of the document - with object ID <parameter>objectID</parameter>. + Returns an array of object ids with anchors of the specified document. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>objectID</parameter></term> + <listitem> + <para> + The document object id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of object ids. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-getrellink.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-getrellink.xml diff -u phpdoc/en/reference/hw/functions/hw-getrellink.xml:1.4 phpdoc/en/reference/hw/functions/hw-getrellink.xml:1.5 --- phpdoc/en/reference/hw/functions/hw-getrellink.xml:1.4 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-getrellink.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id='function.hw-getrellink' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_getrellink</refname> <refpurpose>Get link from source to dest relative to rootid</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_getrellink</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-getusername.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-getusername.xml diff -u phpdoc/en/reference/hw/functions/hw-getusername.xml:1.5 phpdoc/en/reference/hw/functions/hw-getusername.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-getusername.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-getusername.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-getusername" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_getusername</refname> <refpurpose>Name of currently logged in user</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_getusername</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -16,6 +15,27 @@ Returns the username of the connection. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the username as a string. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-info.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-info.xml diff -u phpdoc/en/reference/hw/functions/hw-info.xml:1.5 phpdoc/en/reference/hw/functions/hw-info.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-info.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-info.xml Sat Dec 29 23:04:24 2007 @@ -1,21 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id="function.hw-info" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Info</refname> <refpurpose>Info about connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_info</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns information about the current connection. The returned string - has the following format: <Serverstring>, <Host>, - <Port>, <Username>, <Port of Client>, + Returns information about the current connection. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The returned string has the following format: <Serverstring>, + <Host>, <Port>, <Username>, <Port of Client>, <Byte swapping> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-output-document.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-output-document.xml diff -u phpdoc/en/reference/hw/functions/hw-output-document.xml:1.6 phpdoc/en/reference/hw/functions/hw-output-document.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-output-document.xml:1.6 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-output-document.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-output-document" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Output_Document</refname> <refpurpose>Prints hw_document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_output_document</methodname> <methodparam><type>int</type><parameter>hw_document</parameter></methodparam> @@ -20,6 +19,27 @@ also accepted. This is deprecated, however. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>hw_document</parameter></term> + <listitem> + <para> + The document identifier. + </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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-setlinkroot.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-setlinkroot.xml diff -u phpdoc/en/reference/hw/functions/hw-setlinkroot.xml:1.5 phpdoc/en/reference/hw/functions/hw-setlinkroot.xml:1.6 --- phpdoc/en/reference/hw/functions/hw-setlinkroot.xml:1.5 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-setlinkroot.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.6 $ --> <refentry xml:id='function.hw-setlinkroot' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_setlinkroot</refname> <refpurpose>Set the id to which links are calculated</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>hw_setlinkroot</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-stat.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-stat.xml diff -u phpdoc/en/reference/hw/functions/hw-stat.xml:1.4 phpdoc/en/reference/hw/functions/hw-stat.xml:1.5 --- phpdoc/en/reference/hw/functions/hw-stat.xml:1.4 Sat Dec 29 22:27:07 2007 +++ phpdoc/en/reference/hw/functions/hw-stat.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.23 --> +<!-- $Revision: 1.5 $ --> <refentry xml:id='function.hw-stat' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_stat</refname> <refpurpose>Returns status string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>hw_stat</methodname> <methodparam><type>int</type><parameter>link</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/hw/functions/hw-unlock.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/hw/functions/hw-unlock.xml diff -u phpdoc/en/reference/hw/functions/hw-unlock.xml:1.6 phpdoc/en/reference/hw/functions/hw-unlock.xml:1.7 --- phpdoc/en/reference/hw/functions/hw-unlock.xml:1.6 Sat Dec 29 22:27:08 2007 +++ phpdoc/en/reference/hw/functions/hw-unlock.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry xml:id="function.hw-unlock" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>hw_Unlock</refname> <refpurpose>Unlock object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>hw_unlock</methodname> <methodparam><type>int</type><parameter>connection</parameter></methodparam> @@ -16,8 +15,42 @@ <para> Unlocks a document, so other users regain access. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>connection</parameter></term> + <listitem> + <para> + The connection identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>objectID</parameter></term> + <listitem> + <para> + The document object identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>hw_getandlock</function>. + <simplelist> + <member><function>hw_getandlock</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/strings/functions/htmlspecialchars.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/strings/functions/htmlspecialchars.xml diff -u phpdoc/en/reference/strings/functions/htmlspecialchars.xml:1.11 phpdoc/en/reference/strings/functions/htmlspecialchars.xml:1.12 --- phpdoc/en/reference/strings/functions/htmlspecialchars.xml:1.11 Fri Dec 7 01:18:14 2007 +++ phpdoc/en/reference/strings/functions/htmlspecialchars.xml Sat Dec 29 23:04:24 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.htmlspecialchars" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>htmlspecialchars</refname> <refpurpose>Convert special characters to HTML entities</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>htmlspecialchars</methodname> <methodparam><type>string</type><parameter>string</parameter></methodparam> @@ -27,7 +27,7 @@ <simpara> This function is useful in preventing user-supplied text from containing HTML markup, such as in a message board or guest book - application. + application. </simpara> <para> The translations performed are: @@ -93,7 +93,7 @@ <term><parameter>charset</parameter></term> <listitem> <para> - Defines character set used in conversion. + Defines character set used in conversion. The default character set is ISO-8859-1. </para> &reference.strings.charsets; @@ -111,7 +111,7 @@ </variablelist> </para> </refsect1> - + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -182,7 +182,7 @@ </para> </note> </refsect1> - + <refsect1 role="seealso"> &reftitle.seealso; <para>