reference/bzip2/functions/bzcompress.xml
c564dbc4f35dd39b4415ebbb671f2764a44306a6
...
...
@@ -8,10 +8,10 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>mixed</type><methodname>bzcompress</methodname>
12
-
<methodparam><type>string</type><parameter>source</parameter></methodparam>
13
-
<methodparam choice="opt"><type>int</type><parameter>blocksize</parameter><initializer>4</initializer></methodparam>
14
-
<methodparam choice="opt"><type>int</type><parameter>workfactor</parameter><initializer>0</initializer></methodparam>
11
+
<type class="union"><type>string</type><type>int</type></type><methodname>bzcompress</methodname>
12
+
<methodparam><type>string</type><parameter>data</parameter></methodparam>
13
+
<methodparam choice="opt"><type>int</type><parameter>block_size</parameter><initializer>4</initializer></methodparam>
14
+
<methodparam choice="opt"><type>int</type><parameter>work_factor</parameter><initializer>0</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
<function>bzcompress</function> compresses the given string and returns
...
...
@@ -23,7 +23,7 @@
23
23
<para>
24
24
<variablelist>
25
25
<varlistentry>
26
-
<term><parameter>source</parameter></term>
26
+
<term><parameter>data</parameter></term>
27
27
<listitem>
28
28
<para>
29
29
The string to compress.
...
...
@@ -31,7 +31,7 @@
31
31
</listitem>
32
32
</varlistentry>
33
33
<varlistentry>
34
-
<term><parameter>blocksize</parameter></term>
34
+
<term><parameter>block_size</parameter></term>
35
35
<listitem>
36
36
<para>
37
37
Specifies the blocksize used during compression and should be a number
...
...
@@ -41,7 +41,7 @@
41
41
</listitem>
42
42
</varlistentry>
43
43
<varlistentry>
44
-
<term><parameter>workfactor</parameter></term>
44
+
<term><parameter>work_factor</parameter></term>
45
45
<listitem>
46
46
<para>
47
47
Controls how the compression phase behaves when presented with worst
...
...
@@ -49,7 +49,7 @@
49
49
250 with 0 being a special case.
50
50
</para>
51
51
<para>
52
-
Regardless of the <parameter>workfactor</parameter>, the generated
52
+
Regardless of the <parameter>work_factor</parameter>, the generated
53
53
output is the same.
54
54
</para>
55
55
</listitem>
...
...
@@ -87,7 +87,6 @@ echo $bzstr;
87
87
</para>
88
88
</refsect1>
89
89
</refentry>
90
-

91
90
<!-- Keep this comment at the end of the file
92
91
Local variables:
93
92
mode: sgml
94
93