update params for pending release

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229234 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Greg Beaver 2007-02-07 00:39:13 +00:00
parent 77ef9854ed
commit 7c37eca28e

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.phar-cancompress">
<refnamediv>
<refname>Phar::canCompress</refname>
@ -9,18 +9,30 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>Phar::canCompress</methodname>
<void/>
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
This should be used to test whether compression is possible prior to
loading a phar archive containing compressed files.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
Either <literal>Phar::GZ</literal> or <literal>Phar::BZ2</literal> can be
used to test whether compression is possible with a specific compression
algorithm (zlib or bzip2).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">