reference/phar/PharFileInfo/compress.xml
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
...
...
@@ -1,13 +1,13 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="pharfileinfo.compress">
3
+
<refentry xml:id="pharfileinfo.compress" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>PharFileInfo::compress</refname>
6
6
<refpurpose>Compresses the current Phar entry with either zlib or bzip2 compression</refpurpose>
7
7
</refnamediv>
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
-
<methodsynopsis>
10
+
<methodsynopsis role="PharFileInfo">
11
11
<modifier>public</modifier> <type>bool</type><methodname>PharFileInfo::compress</methodname>
12
12
<methodparam><type>int</type><parameter>compression</parameter></methodparam>
13
13
</methodsynopsis>
...
...
@@ -27,6 +27,22 @@
27
27
</para>
28
28
</refsect1>
29
29
30
+
<refsect1 role="parameters">
31
+
&reftitle.parameters;
32
+
<para>
33
+
<variablelist>
34
+
<varlistentry>
35
+
<term><parameter>compression</parameter></term>
36
+
<listitem>
37
+
<para>
38
+
Compression must be <constant>Phar::GZ</constant> or <constant>Phar::BZ2</constant>.
39
+
</para>
40
+
</listitem>
41
+
</varlistentry>
42
+
</variablelist>
43
+
</para>
44
+
</refsect1>
45
+
30
46
<refsect1 role="returnvalues">
31
47
&reftitle.returnvalues;
32
48
<para>
...
...
@@ -96,7 +112,6 @@ bool(true)
96
112
</refsect1>
97
113
98
114
</refentry>
99
-
100
115
<!-- Keep this comment at the end of the file
101
116
Local variables:
102
117
mode: sgml
103
118