reference/bzip2/functions/bzdecompress.xml
c564dbc4f35dd39b4415ebbb671f2764a44306a6
c564dbc4f35dd39b4415ebbb671f2764a44306a6
...
...
@@ -8,9 +8,9 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>mixed</type><methodname>bzdecompress</methodname>
12
-
<methodparam><type>string</type><parameter>source</parameter></methodparam>
13
-
<methodparam choice="opt"><type>int</type><parameter>small</parameter><initializer>0</initializer></methodparam>
11
+
<type class="union"><type>string</type><type>int</type><type>false</type></type><methodname>bzdecompress</methodname>
12
+
<methodparam><type>string</type><parameter>data</parameter></methodparam>
13
+
<methodparam choice="opt"><type>bool</type><parameter>use_less_memory</parameter><initializer>&false;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>bzdecompress</function> decompresses the given string containing
...
...
@@ -22,7 +22,7 @@
22
22
<para>
23
23
<variablelist>
24
24
<varlistentry>
25
-
<term><parameter>source</parameter></term>
25
+
<term><parameter>data</parameter></term>
26
26
<listitem>
27
27
<para>
28
28
The string to decompress.
...
...
@@ -30,7 +30,7 @@
30
30
</listitem>
31
31
</varlistentry>
32
32
<varlistentry>
33
-
<term><parameter>small</parameter></term>
33
+
<term><parameter>use_less_memory</parameter></term>
34
34
<listitem>
35
35
<para>
36
36
If &true;, an alternative decompression algorithm will be used which
...
...
@@ -49,9 +49,34 @@
49
49
<refsect1 role="returnvalues">
50
50
&reftitle.returnvalues;
51
51
<para>
52
-
The decompressed string, or an error number if an error occurred.
52
+
The decompressed string, or &false; or an error number if an error occurred.
53
53
</para>
54
54
</refsect1>
55
+
56
+
<refsect1 role="changelog">
57
+
&reftitle.changelog;
58
+
<informaltable>
59
+
<tgroup cols="2">
60
+
<thead>
61
+
<row>
62
+
<entry>&Version;</entry>
63
+
<entry>&Description;</entry>
64
+
</row>
65
+
</thead>
66
+
<tbody>
67
+
<row>
68
+
<entry>8.0.0</entry>
69
+
<entry>
70
+
The type of <parameter>use_less_memory</parameter> has been changed from
71
+
<type>int</type> to <type>bool</type>. Previously, the default value was
72
+
<literal>0</literal>.
73
+
</entry>
74
+
</row>
75
+
</tbody>
76
+
</tgroup>
77
+
</informaltable>
78
+
</refsect1>
79
+
55
80
<refsect1 role="examples">
56
81
&reftitle.examples;
57
82
<para>
...
...
@@ -86,7 +111,6 @@ echo "\n<br />\n";
86
111
</para>
87
112
</refsect1>
88
113
</refentry>
89
-
90
114
<!-- Keep this comment at the end of the file
91
115
Local variables:
92
116
mode: sgml
93
117