cvs: phpdoc /en/reference/bzip2/functions bzclose.xml bzcompress.xml bzdecompress.xml bzerrno.xml bzerror.xml bzerrstr.xml bzflush.xml bzopen.xml
bzread.xml bzwrite.xml
| From: | Mehdi Achour | Date: | Sun, 30 Jan 2005 01:46:49 +0000 |
| Subject: | cvs: phpdoc /en/reference/bzip2/functions bzclose.xml bzcompress.xml bzdecompress.xml bzerrno.xml bzerror.xml bzerrstr.xml bzflush.xml bzopen.xml bzread.xml bzwrite.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969366257@lists.php.net to get a copy of this message | ||
didou Sat Jan 29 20:46:49 2005 EDT
Modified files:
/phpdoc/en/reference/bzip2/functions bzclose.xml bzcompress.xml
bzdecompress.xml bzerrno.xml
bzerror.xml bzerrstr.xml
bzflush.xml bzopen.xml
bzread.xml bzwrite.xml
Log:
Migrate docs to the new style
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzclose.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/bzip2/functions/bzclose.xml diff -u phpdoc/en/reference/bzip2/functions/bzclose.xml:1.3 phpdoc/en/reference/bzip2/functions/bzclose.xml:1.4 --- phpdoc/en/reference/bzip2/functions/bzclose.xml:1.3 Wed Jun 16 17:35:43 2004 +++ phpdoc/en/reference/bzip2/functions/bzclose.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.bzclose"> <refnamediv> <refname>bzclose</refname> <refpurpose>Close a bzip2 file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bzclose</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> @@ -15,18 +14,35 @@ <para> Closes the bzip2 file referenced by the pointer <parameter>bz</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The file pointer must be valid, and must point to a file - successfully opened by <function>bzopen</function>. + &return.success; </para> </refsect1> - <refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bzopen</function>. + <simplelist> + <member><function>bzopen</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzcompress.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/bzip2/functions/bzcompress.xml diff -u phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.7 phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.8 --- phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.7 Mon Nov 1 08:25:29 2004 +++ phpdoc/en/reference/bzip2/functions/bzcompress.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.bzcompress"> <refnamediv> <refname>bzcompress</refname> <refpurpose>Compress a string into bzip2 encoded data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bzcompress</methodname> <methodparam><type>string</type><parameter>source</parameter></methodparam> @@ -15,33 +14,58 @@ <methodparam choice="opt"><type>int</type><parameter>workfactor</parameter></methodparam> </methodsynopsis> <para> - <function>bzcompress</function> compresses the - <parameter>source</parameter> string and returns it as bzip2 - encoded data. + <function>bzcompress</function> compresses the given string and returns + it as bzip2 encoded data. </para> <para> - The optional parameter <parameter>blocksize</parameter> specifies - the blocksize used during compression and should be a number from - 1 to 9 with 9 giving the best compression, but using more - resources to do so. <parameter>blocksize</parameter> defaults to - 4. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The optional parameter <parameter>workfactor</parameter> controls - how the compression phase behaves when presented with worst case, - highly repetitive, input data. The value can be between 0 and - 250 with 0 being a special case and 30 being the default - value. Regardless of the <parameter>workfactor</parameter>, the - generated output is the same. + <variablelist> + <varlistentry> + <term><parameter>source</parameter></term> + <listitem> + <para> + The string to compress. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blocksize</parameter></term> + <listitem> + <para> + Specifies the blocksize used during compression and should be a number + from 1 to 9 with 9 giving the best compression, but using more resources + to do so. <parameter>blocksize</parameter> defaults to 4. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>workfactor</parameter></term> + <listitem> + <para> + Controls how the compression phase behaves when presented with worst + case, highly repetitive, input data. The value can be between 0 and + 250 with 0 being a special case and 30 being the default value. + </para> + <para> + Regardless of the <parameter>workfactor</parameter>, the generated + output is the same. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>bzdecompress</function>. + The compressed string. </para> </refsect1> - <refsect1> + <refsect1 role="examples"> &reftitle.examples; <example> <title>Compressing data</title> @@ -56,6 +80,14 @@ </programlisting> </example> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>bzdecompress</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzdecompress.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/bzip2/functions/bzdecompress.xml diff -u phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.8 phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.9 --- phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.8 Mon Nov 1 08:25:29 2004 +++ phpdoc/en/reference/bzip2/functions/bzdecompress.xml Sat Jan 29 20:46:49 2005 @@ -1,37 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.9 $ --> <refentry id="function.bzdecompress"> <refnamediv> <refname>bzdecompress</refname> <refpurpose>Decompresses bzip2 encoded data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bzdecompress</methodname> <methodparam><type>string</type><parameter>source</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>small</parameter></methodparam> </methodsynopsis> <para> - <function>bzdecompress</function> decompresses the - <parameter>source</parameter> string containing bzip2 encoded - data and returns it. If the optional parameter - <parameter>small</parameter> is &true;, an alternative - decompression algorithm will be used which uses less memory (the - maximum memory requirement drops to around 2300K) but works at - roughly half the speed. See the <ulink url="&url.bzip2;">bzip2 - documentation</ulink> for more information about this feature. + <function>bzdecompress</function> decompresses the given string containing + bzip2 encoded data. </para> </refsect1> - <refsect1> - &reftitle.seealso; + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>bzcompress</function>. + <variablelist> + <varlistentry> + <term><parameter>source</parameter></term> + <listitem> + <para> + The string to decompress. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>small</parameter></term> + <listitem> + <para> + If &true;, an alternative decompression algorithm will be used which + uses less memory (the maximum memory requirement drops to around 2300K) + but works at roughly half the speed. + </para> + <para> + See the <ulink url="&url.bzip2;">bzip2 documentation</ulink> for more + information about this feature. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The decompressed string. + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; + <para> <example> <title>Decompressing a String</title> <programlisting role="php"> @@ -52,6 +75,15 @@ ]]> </programlisting> </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>bzcompress</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerrno.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/bzip2/functions/bzerrno.xml diff -u phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.3 phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.4 --- phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.3 Wed Jun 16 17:35:43 2004 +++ phpdoc/en/reference/bzip2/functions/bzerrno.xml Sat Jan 29 20:46:49 2005 @@ -1,27 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.bzerrno"> <refnamediv> <refname>bzerrno</refname> <refpurpose>Returns a bzip2 error number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bzerrno</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> </methodsynopsis> <para> - Returns the error number of any bzip2 error returned by the file - pointer <parameter>bz</parameter>. + Returns the error number of any bzip2 error returned by the given file + pointer. </para> </refsect1> - <refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the error number as an interger. + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bzerror</function>, - <function>bzerrstr</function>. + <simplelist> + <member><function>bzerror</function></member> + <member><function>bzerrstr</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerror.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/bzip2/functions/bzerror.xml diff -u phpdoc/en/reference/bzip2/functions/bzerror.xml:1.4 phpdoc/en/reference/bzip2/functions/bzerror.xml:1.5 --- phpdoc/en/reference/bzip2/functions/bzerror.xml:1.4 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzerror.xml Sat Jan 29 20:46:49 2005 @@ -1,22 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bzerror"> <refnamediv> <refname>bzerror</refname> <refpurpose>Returns the bzip2 error number and error string in an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>bzerror</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> </methodsynopsis> <para> - Returns the error number and error string, in an associative array, - of any bzip2 error returned by the file pointer - <parameter>bz</parameter>. + Returns the error number and error string of any bzip2 error returned by + the given file pointer. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array, with the error code in the + <literal>errno</literal> entry, and the error message in the + <literal>errstr</literal> entry. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bzerror</function> example</title> @@ -32,9 +57,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzerrno</function> and - <function>bzerrstr</function>. + <simplelist> + <member><function>bzerrno</function></member> + <member><function>bzerrstr</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerrstr.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/bzip2/functions/bzerrstr.xml diff -u phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.4 phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.5 --- phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.4 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzerrstr.xml Sat Jan 29 20:46:49 2005 @@ -1,24 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bzerrstr"> <refnamediv> <refname>bzerrstr</refname> <refpurpose>Returns a bzip2 error string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bzerrstr</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> </methodsynopsis> <para> - Returns the error string of any bzip2 error returned by the file - pointer <parameter>bz</parameter>. + Gets the error string of any bzip2 error returned by the given file + pointer. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string containing the error message. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzerrno</function> and - <function>bzerror</function>. + <simplelist> + <member><function>bzerrno</function></member> + <member><function>bzerror</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzflush.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/bzip2/functions/bzflush.xml diff -u phpdoc/en/reference/bzip2/functions/bzflush.xml:1.3 phpdoc/en/reference/bzip2/functions/bzflush.xml:1.4 --- phpdoc/en/reference/bzip2/functions/bzflush.xml:1.3 Wed Jun 16 17:35:43 2004 +++ phpdoc/en/reference/bzip2/functions/bzflush.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.bzflush"> <refnamediv> <refname>bzflush</refname> <refpurpose>Force a write of all buffered data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bzflush</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> @@ -17,17 +16,35 @@ <parameter>bz</parameter>. </para> </refsect1> - <refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> - <refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bzread</function>, - <function>bzwrite</function>. + <simplelist> + <member><function>bzread</function></member> + <member><function>bzwrite</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzopen.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/bzip2/functions/bzopen.xml diff -u phpdoc/en/reference/bzip2/functions/bzopen.xml:1.7 phpdoc/en/reference/bzip2/functions/bzopen.xml:1.8 --- phpdoc/en/reference/bzip2/functions/bzopen.xml:1.7 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzopen.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.bzopen"> <refnamediv> <refname>bzopen</refname> <refpurpose>Opens a bzip2 compressed file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>bzopen</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -15,14 +14,41 @@ </methodsynopsis> <para> <function>bzopen</function> opens a bzip2 (.bz2) file for reading or writing. - <parameter>filename</parameter> is the name of the file to - open. <parameter>mode</parameter> is similar to the - <function>fopen</function> function (`r' for read, `w' for write, etc.). </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The name of the file to open. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + Similar to the <function>fopen</function> function ('r' for read, 'w' for + write, etc.). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> If the open fails, <function>bzopen</function> returns &false;, otherwise it returns a pointer to the newly opened file. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bzopen</function> example</title> @@ -40,8 +66,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzclose</function>. + <simplelist> + <member><function>bzclose</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzread.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/bzip2/functions/bzread.xml diff -u phpdoc/en/reference/bzip2/functions/bzread.xml:1.8 phpdoc/en/reference/bzip2/functions/bzread.xml:1.9 --- phpdoc/en/reference/bzip2/functions/bzread.xml:1.8 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzread.xml Sat Jan 29 20:46:49 2005 @@ -1,29 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.9 $ --> <refentry id="function.bzread"> <refnamediv> <refname>bzread</refname> <refpurpose>Binary safe bzip2 file read</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bzread</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> </methodsynopsis> <para> - <function>bzread</function> reads up to - <parameter>length</parameter> bytes from the bzip2 file pointer - referenced by <parameter>bz</parameter>. Reading stops when - <parameter>length</parameter> (uncompressed) bytes have been read - or EOF is reached, whichever comes first. If the optional - parameter <parameter>length</parameter> is not specified, - <function>bzread</function> will read 1024 (uncompressed) bytes - at a time. + <function>bzread</function> reads from the given bzip2 file pointer. </para> <para> + Reading stops when <parameter>length</parameter> (uncompressed) bytes have been read + or EOF is reached, whichever comes first. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + If not specified, <function>bzread</function> will read 1024 + (uncompressed) bytes at a time. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the uncompressed data, or &false; on error. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title><function>bzread</function> example</title> <programlisting role="php"> @@ -47,10 +77,15 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzwrite</function>, - <function>feof</function> and - <function>bzopen</function>. + <simplelist> + <member><function>bzwrite</function></member> + <member><function>feof</function></member> + <member><function>bzopen</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzwrite.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/bzip2/functions/bzwrite.xml diff -u phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.4 phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.5 --- phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.4 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzwrite.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bzwrite"> <refnamediv> <refname>bzwrite</refname> <refpurpose>Binary safe bzip2 file write</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bzwrite</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> @@ -15,13 +14,52 @@ <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> </methodsynopsis> <para> - <function>bzwrite</function> writes the contents of the string - <parameter>data</parameter> to the bzip2 file stream pointed to - by <parameter>bz</parameter>. If the optional - <parameter>length</parameter> argument is given, writing will stop - after length (uncompressed) bytes have been written or the end of - string is reached, whichever comes first. + <function>bzwrite</function> writes a string into the given bzip2 file + stream. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The written data. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + If supplied, writing will stop after <parameter>length</parameter> + (uncompressed) bytes have been written or the end of + <parameter>data</parameter> is reached, whichever comes first. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of bytes written, or &false; on error. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bzwrite</function> example</title> @@ -37,9 +75,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzread</function> and - <function>bzopen</function>. + <simplelist> + <member><function>bzread</function></member> + <member><function>bzopen</function></member> + </simplelist> </para> </refsect1> </refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzclose.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/bzip2/functions/bzclose.xml diff -u phpdoc/en/reference/bzip2/functions/bzclose.xml:1.3 phpdoc/en/reference/bzip2/functions/bzclose.xml:1.4 --- phpdoc/en/reference/bzip2/functions/bzclose.xml:1.3 Wed Jun 16 17:35:43 2004 +++ phpdoc/en/reference/bzip2/functions/bzclose.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.bzclose"> <refnamediv> <refname>bzclose</refname> <refpurpose>Close a bzip2 file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bzclose</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> @@ -15,18 +14,35 @@ <para> Closes the bzip2 file referenced by the pointer <parameter>bz</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &return.success; + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The file pointer must be valid, and must point to a file - successfully opened by <function>bzopen</function>. + &return.success; </para> </refsect1> - <refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bzopen</function>. + <simplelist> + <member><function>bzopen</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzcompress.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/bzip2/functions/bzcompress.xml diff -u phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.7 phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.8 --- phpdoc/en/reference/bzip2/functions/bzcompress.xml:1.7 Mon Nov 1 08:25:29 2004 +++ phpdoc/en/reference/bzip2/functions/bzcompress.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.bzcompress"> <refnamediv> <refname>bzcompress</refname> <refpurpose>Compress a string into bzip2 encoded data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bzcompress</methodname> <methodparam><type>string</type><parameter>source</parameter></methodparam> @@ -15,33 +14,58 @@ <methodparam choice="opt"><type>int</type><parameter>workfactor</parameter></methodparam> </methodsynopsis> <para> - <function>bzcompress</function> compresses the - <parameter>source</parameter> string and returns it as bzip2 - encoded data. + <function>bzcompress</function> compresses the given string and returns + it as bzip2 encoded data. </para> <para> - The optional parameter <parameter>blocksize</parameter> specifies - the blocksize used during compression and should be a number from - 1 to 9 with 9 giving the best compression, but using more - resources to do so. <parameter>blocksize</parameter> defaults to - 4. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The optional parameter <parameter>workfactor</parameter> controls - how the compression phase behaves when presented with worst case, - highly repetitive, input data. The value can be between 0 and - 250 with 0 being a special case and 30 being the default - value. Regardless of the <parameter>workfactor</parameter>, the - generated output is the same. + <variablelist> + <varlistentry> + <term><parameter>source</parameter></term> + <listitem> + <para> + The string to compress. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blocksize</parameter></term> + <listitem> + <para> + Specifies the blocksize used during compression and should be a number + from 1 to 9 with 9 giving the best compression, but using more resources + to do so. <parameter>blocksize</parameter> defaults to 4. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>workfactor</parameter></term> + <listitem> + <para> + Controls how the compression phase behaves when presented with worst + case, highly repetitive, input data. The value can be between 0 and + 250 with 0 being a special case and 30 being the default value. + </para> + <para> + Regardless of the <parameter>workfactor</parameter>, the generated + output is the same. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> - &reftitle.seealso; + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>bzdecompress</function>. + The compressed string. </para> </refsect1> - <refsect1> + <refsect1 role="examples"> &reftitle.examples; <example> <title>Compressing data</title> @@ -56,6 +80,14 @@ </programlisting> </example> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>bzdecompress</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzdecompress.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/bzip2/functions/bzdecompress.xml diff -u phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.8 phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.9 --- phpdoc/en/reference/bzip2/functions/bzdecompress.xml:1.8 Mon Nov 1 08:25:29 2004 +++ phpdoc/en/reference/bzip2/functions/bzdecompress.xml Sat Jan 29 20:46:49 2005 @@ -1,37 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.9 $ --> <refentry id="function.bzdecompress"> <refnamediv> <refname>bzdecompress</refname> <refpurpose>Decompresses bzip2 encoded data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bzdecompress</methodname> <methodparam><type>string</type><parameter>source</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>small</parameter></methodparam> </methodsynopsis> <para> - <function>bzdecompress</function> decompresses the - <parameter>source</parameter> string containing bzip2 encoded - data and returns it. If the optional parameter - <parameter>small</parameter> is &true;, an alternative - decompression algorithm will be used which uses less memory (the - maximum memory requirement drops to around 2300K) but works at - roughly half the speed. See the <ulink url="&url.bzip2;">bzip2 - documentation</ulink> for more information about this feature. + <function>bzdecompress</function> decompresses the given string containing + bzip2 encoded data. </para> </refsect1> - <refsect1> - &reftitle.seealso; + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>bzcompress</function>. + <variablelist> + <varlistentry> + <term><parameter>source</parameter></term> + <listitem> + <para> + The string to decompress. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>small</parameter></term> + <listitem> + <para> + If &true;, an alternative decompression algorithm will be used which + uses less memory (the maximum memory requirement drops to around 2300K) + but works at roughly half the speed. + </para> + <para> + See the <ulink url="&url.bzip2;">bzip2 documentation</ulink> for more + information about this feature. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The decompressed string. + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; + <para> <example> <title>Decompressing a String</title> <programlisting role="php"> @@ -52,6 +75,15 @@ ]]> </programlisting> </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>bzcompress</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerrno.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/bzip2/functions/bzerrno.xml diff -u phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.3 phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.4 --- phpdoc/en/reference/bzip2/functions/bzerrno.xml:1.3 Wed Jun 16 17:35:43 2004 +++ phpdoc/en/reference/bzip2/functions/bzerrno.xml Sat Jan 29 20:46:49 2005 @@ -1,27 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.bzerrno"> <refnamediv> <refname>bzerrno</refname> <refpurpose>Returns a bzip2 error number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bzerrno</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> </methodsynopsis> <para> - Returns the error number of any bzip2 error returned by the file - pointer <parameter>bz</parameter>. + Returns the error number of any bzip2 error returned by the given file + pointer. </para> </refsect1> - <refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the error number as an interger. + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bzerror</function>, - <function>bzerrstr</function>. + <simplelist> + <member><function>bzerror</function></member> + <member><function>bzerrstr</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerror.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/bzip2/functions/bzerror.xml diff -u phpdoc/en/reference/bzip2/functions/bzerror.xml:1.4 phpdoc/en/reference/bzip2/functions/bzerror.xml:1.5 --- phpdoc/en/reference/bzip2/functions/bzerror.xml:1.4 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzerror.xml Sat Jan 29 20:46:49 2005 @@ -1,22 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bzerror"> <refnamediv> <refname>bzerror</refname> <refpurpose>Returns the bzip2 error number and error string in an array</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>bzerror</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> </methodsynopsis> <para> - Returns the error number and error string, in an associative array, - of any bzip2 error returned by the file pointer - <parameter>bz</parameter>. + Returns the error number and error string of any bzip2 error returned by + the given file pointer. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array, with the error code in the + <literal>errno</literal> entry, and the error message in the + <literal>errstr</literal> entry. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bzerror</function> example</title> @@ -32,9 +57,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzerrno</function> and - <function>bzerrstr</function>. + <simplelist> + <member><function>bzerrno</function></member> + <member><function>bzerrstr</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzerrstr.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/bzip2/functions/bzerrstr.xml diff -u phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.4 phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.5 --- phpdoc/en/reference/bzip2/functions/bzerrstr.xml:1.4 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzerrstr.xml Sat Jan 29 20:46:49 2005 @@ -1,24 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bzerrstr"> <refnamediv> <refname>bzerrstr</refname> <refpurpose>Returns a bzip2 error string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bzerrstr</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> </methodsynopsis> <para> - Returns the error string of any bzip2 error returned by the file - pointer <parameter>bz</parameter>. + Gets the error string of any bzip2 error returned by the given file + pointer. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a string containing the error message. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzerrno</function> and - <function>bzerror</function>. + <simplelist> + <member><function>bzerrno</function></member> + <member><function>bzerror</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzflush.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/bzip2/functions/bzflush.xml diff -u phpdoc/en/reference/bzip2/functions/bzflush.xml:1.3 phpdoc/en/reference/bzip2/functions/bzflush.xml:1.4 --- phpdoc/en/reference/bzip2/functions/bzflush.xml:1.3 Wed Jun 16 17:35:43 2004 +++ phpdoc/en/reference/bzip2/functions/bzflush.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.bzflush"> <refnamediv> <refname>bzflush</refname> <refpurpose>Force a write of all buffered data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bzflush</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> @@ -17,17 +16,35 @@ <parameter>bz</parameter>. </para> </refsect1> - <refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> - <refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> - <function>bzread</function>, - <function>bzwrite</function>. + <simplelist> + <member><function>bzread</function></member> + <member><function>bzwrite</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzopen.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/bzip2/functions/bzopen.xml diff -u phpdoc/en/reference/bzip2/functions/bzopen.xml:1.7 phpdoc/en/reference/bzip2/functions/bzopen.xml:1.8 --- phpdoc/en/reference/bzip2/functions/bzopen.xml:1.7 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzopen.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.bzopen"> <refnamediv> <refname>bzopen</refname> <refpurpose>Opens a bzip2 compressed file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>bzopen</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -15,14 +14,41 @@ </methodsynopsis> <para> <function>bzopen</function> opens a bzip2 (.bz2) file for reading or writing. - <parameter>filename</parameter> is the name of the file to - open. <parameter>mode</parameter> is similar to the - <function>fopen</function> function (`r' for read, `w' for write, etc.). </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The name of the file to open. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + Similar to the <function>fopen</function> function ('r' for read, 'w' for + write, etc.). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> If the open fails, <function>bzopen</function> returns &false;, otherwise it returns a pointer to the newly opened file. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bzopen</function> example</title> @@ -40,8 +66,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzclose</function>. + <simplelist> + <member><function>bzclose</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzread.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/bzip2/functions/bzread.xml diff -u phpdoc/en/reference/bzip2/functions/bzread.xml:1.8 phpdoc/en/reference/bzip2/functions/bzread.xml:1.9 --- phpdoc/en/reference/bzip2/functions/bzread.xml:1.8 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzread.xml Sat Jan 29 20:46:49 2005 @@ -1,29 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.9 $ --> <refentry id="function.bzread"> <refnamediv> <refname>bzread</refname> <refpurpose>Binary safe bzip2 file read</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>bzread</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> </methodsynopsis> <para> - <function>bzread</function> reads up to - <parameter>length</parameter> bytes from the bzip2 file pointer - referenced by <parameter>bz</parameter>. Reading stops when - <parameter>length</parameter> (uncompressed) bytes have been read - or EOF is reached, whichever comes first. If the optional - parameter <parameter>length</parameter> is not specified, - <function>bzread</function> will read 1024 (uncompressed) bytes - at a time. + <function>bzread</function> reads from the given bzip2 file pointer. </para> <para> + Reading stops when <parameter>length</parameter> (uncompressed) bytes have been read + or EOF is reached, whichever comes first. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + If not specified, <function>bzread</function> will read 1024 + (uncompressed) bytes at a time. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the uncompressed data, or &false; on error. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title><function>bzread</function> example</title> <programlisting role="php"> @@ -47,10 +77,15 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzwrite</function>, - <function>feof</function> and - <function>bzopen</function>. + <simplelist> + <member><function>bzwrite</function></member> + <member><function>feof</function></member> + <member><function>bzopen</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/bzip2/functions/bzwrite.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/bzip2/functions/bzwrite.xml diff -u phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.4 phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.5 --- phpdoc/en/reference/bzip2/functions/bzwrite.xml:1.4 Thu Jun 17 08:09:53 2004 +++ phpdoc/en/reference/bzip2/functions/bzwrite.xml Sat Jan 29 20:46:49 2005 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.bzwrite"> <refnamediv> <refname>bzwrite</refname> <refpurpose>Binary safe bzip2 file write</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>bzwrite</methodname> <methodparam><type>resource</type><parameter>bz</parameter></methodparam> @@ -15,13 +14,52 @@ <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam> </methodsynopsis> <para> - <function>bzwrite</function> writes the contents of the string - <parameter>data</parameter> to the bzip2 file stream pointed to - by <parameter>bz</parameter>. If the optional - <parameter>length</parameter> argument is given, writing will stop - after length (uncompressed) bytes have been written or the end of - string is reached, whichever comes first. + <function>bzwrite</function> writes a string into the given bzip2 file + stream. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>bz</parameter></term> + <listitem> + <para> + The file pointer. It must be valid and must point to a file successfully + opened by <function>bzopen</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The written data. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>length</parameter></term> + <listitem> + <para> + If supplied, writing will stop after <parameter>length</parameter> + (uncompressed) bytes have been written or the end of + <parameter>data</parameter> is reached, whichever comes first. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of bytes written, or &false; on error. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>bzwrite</function> example</title> @@ -37,9 +75,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>bzread</function> and - <function>bzopen</function>. + <simplelist> + <member><function>bzread</function></member> + <member><function>bzopen</function></member> + </simplelist> </para> </refsect1> </refentry>