Skip to content

Commit c32ce01

Browse files
kocsismatekocsismate
committed
Sync some methodsynopses with stubs
1 parent c5402f6 commit c32ce01

File tree

14 files changed

+60
-27
lines changed

14 files changed

+60
-27
lines changed

‎reference/fileinfo/functions/finfo-set-flags.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
&reftitle.description;
1212
<para>&style.procedural;</para>
1313
<methodsynopsis>
14-
<type>bool</type><methodname>finfo_set_flags</methodname>
14+
<type>true</type><methodname>finfo_set_flags</methodname>
1515
<methodparam><type>finfo</type><parameter>finfo</parameter></methodparam>
1616
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
1717
</methodsynopsis>
@@ -52,7 +52,7 @@
5252
<refsect1 role="returnvalues">
5353
&reftitle.returnvalues;
5454
<para>
55-
&return.success;
55+
&return.true.always;
5656
</para>
5757
</refsect1>
5858

‎reference/hash/functions/hash-pbkdf2.xml‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.hash-pbkdf2">
3+
<refentry xml:id="function.hash-pbkdf2" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
44
<refnamediv>
55
<refname>hash_pbkdf2</refname>
66
<refpurpose>Generate a PBKDF2 key derivation of a supplied password</refpurpose>
@@ -16,6 +16,7 @@
1616
<methodparam><type>int</type><parameter>iterations</parameter></methodparam>
1717
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
1818
<methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</initializer></methodparam>
19+
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
1920
</methodsynopsis>
2021
</refsect1>
2122

@@ -82,6 +83,15 @@
8283
</para>
8384
</listitem>
8485
</varlistentry>
86+
<varlistentry>
87+
<term><parameter>options</parameter></term>
88+
<listitem>
89+
<para>
90+
An array of options for the various hashing algorithms. Currently, only the "seed" parameter is
91+
supported by the MurmurHash variants.
92+
</para>
93+
</listitem>
94+
</varlistentry>
8595
</variablelist>
8696
</para>
8797
</refsect1>

‎reference/hash/functions/hash-update.xml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis>
11-
<type>bool</type><methodname>hash_update</methodname>
11+
<type>true</type><methodname>hash_update</methodname>
1212
<methodparam><type>HashContext</type><parameter>context</parameter></methodparam>
1313
<methodparam><type>string</type><parameter>data</parameter></methodparam>
1414
</methodsynopsis>
@@ -41,7 +41,7 @@
4141
<refsect1 role="returnvalues">
4242
&reftitle.returnvalues;
4343
<para>
44-
Returns &true;.
44+
&return.true.always;
4545
</para>
4646
</refsect1>
4747

@@ -82,7 +82,6 @@
8282
</refsect1>
8383

8484
</refentry>
85-
8685
<!-- Keep this comment at the end of the file
8786
Local variables:
8887
mode: sgml

‎reference/ldap/functions/ldap-exop-sync.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
<type class="union"><type>LDAP\Result</type><type>bool</type></type><methodname>ldap_exop_sync</methodname>
1212
<methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
1313
<methodparam><type>string</type><parameter>request_oid</parameter></methodparam>
14-
<methodparam choice="opt"><type>string</type><parameter>request_data</parameter><initializer>&null;</initializer></methodparam>
15-
<methodparam choice="opt"><type>array</type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
14+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>request_data</parameter><initializer>&null;</initializer></methodparam>
15+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer><constant>&null;</constant></initializer></methodparam>
1616
<methodparam choice="opt"><type>string</type><parameter role="reference">response_data</parameter><initializer>&null;</initializer></methodparam>
1717
<methodparam choice="opt"><type>string</type><parameter role="reference">response_oid</parameter><initializer>&null;</initializer></methodparam>
1818
</methodsynopsis>

‎reference/mbstring/functions/mb-get-info.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<refsect1 role="description">
1010
&reftitle.description;
1111
<methodsynopsis>
12-
<type class="union"><type>array</type><type>string</type><type>int</type><type>false</type></type><methodname>mb_get_info</methodname>
12+
<type class="union"><type>array</type><type>string</type><type>int</type><type>false</type><type>null</type></type><methodname>mb_get_info</methodname>
1313
<methodparam choice="opt"><type>string</type><parameter>type</parameter><initializer>"all"</initializer></methodparam>
1414
</methodsynopsis>
1515
<simpara>

‎reference/network/functions/openlog.xml‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<refsect1 role="description">
1010
&reftitle.description;
1111
<methodsynopsis>
12-
<type>bool</type><methodname>openlog</methodname>
12+
<type>true</type><methodname>openlog</methodname>
1313
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
1414
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
1515
<methodparam><type>int</type><parameter>facility</parameter></methodparam>
@@ -181,10 +181,32 @@
181181
<refsect1 role="returnvalues">
182182
&reftitle.returnvalues;
183183
<para>
184-
&return.success;
184+
&return.true.always;
185185
</para>
186186
</refsect1>
187187

188+
<refsect1 role="changelog">
189+
&reftitle.changelog;
190+
<informaltable>
191+
<tgroup cols="2">
192+
<thead>
193+
<row>
194+
<entry>&Version;</entry>
195+
<entry>&Description;</entry>
196+
</row>
197+
</thead>
198+
<tbody>
199+
<row>
200+
<entry>8.2.0</entry>
201+
<entry>
202+
The function now always returns &true;. Previously it returned &false; on failure.
203+
</entry>
204+
</row>
205+
</tbody>
206+
</tgroup>
207+
</informaltable>
208+
</refsect1>
209+
188210
<refsect1 role="seealso">
189211
&reftitle.seealso;
190212
<para>

‎reference/reflection/reflectionfiber/getexecutingfile.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis role="ReflectionFiber">
11-
<modifier>public</modifier> <type>string</type><methodname>ReflectionFiber::getExecutingFile</methodname>
11+
<modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>ReflectionFiber::getExecutingFile</methodname>
1212
<void/>
1313
</methodsynopsis>
1414
<para>
@@ -25,7 +25,8 @@
2525
<refsect1 role="returnvalues">
2626
&reftitle.returnvalues;
2727
<para>
28-
The full path and file name of the reflected fiber.
28+
The full path and file name of the reflected fiber. If the reflected fiber is used outside a user-defined function,
29+
&null; is returned.
2930
</para>
3031
</refsect1>
3132

‎reference/reflection/reflectionfiber/getexecutingline.xml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis role="ReflectionFiber">
11-
<modifier>public</modifier> <type>int</type><methodname>ReflectionFiber::getExecutingLine</methodname>
11+
<modifier>public</modifier> <type class="union"><type>int</type><type>null</type></type><methodname>ReflectionFiber::getExecutingLine</methodname>
1212
<void/>
1313
</methodsynopsis>
1414
<para>
15-
Returns the line number of the current execution point in the reflected <classname>Fiber</classname>. If the fiber
16-
has not been started or has terminated, an <classname>Error</classname> is thrown.
15+
Returns the line number of the current execution point in the reflected <classname>Fiber</classname>. If the reflected
16+
fiber is used outside a user-defined function, &null; is returned. If the fiber has not been started or has terminated,
17+
an <classname>Error</classname> is thrown.
1718
</para>
1819
</refsect1>
1920

‎reference/sockets/functions/socket-create-listen.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<methodsynopsis>
1212
<type class="union"><type>Socket</type><type>false</type></type><methodname>socket_create_listen</methodname>
1313
<methodparam><type>int</type><parameter>port</parameter></methodparam>
14-
<methodparam choice="opt"><type>int</type><parameter>backlog</parameter><initializer>128</initializer></methodparam>
14+
<methodparam choice="opt"><type>int</type><parameter>backlog</parameter><initializer><constant>SOMAXCONN</constant></initializer></methodparam>
1515
</methodsynopsis>
1616
<para>
1717
<function>socket_create_listen</function> creates a new <classname>Socket</classname> instance of

‎reference/uodbc/functions/odbc-autocommit.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<methodsynopsis>
1111
<type class="union"><type>int</type><type>bool</type></type><methodname>odbc_autocommit</methodname>
1212
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
13-
<methodparam choice="opt"><type>bool</type><parameter>enable</parameter><initializer>&null;</initializer></methodparam>
13+
<methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>enable</parameter><initializer>&null;</initializer></methodparam>
1414
</methodsynopsis>
1515
<para>
1616
Toggles autocommit behaviour.
@@ -47,13 +47,13 @@
4747
<refsect1 role="returnvalues">
4848
&reftitle.returnvalues;
4949
<para>
50-
Without the <parameter>enable</parameter> parameter, this function returns
50+
With a &null; <parameter>enable</parameter> parameter, this function returns
5151
auto-commit status for <parameter>odbc</parameter>. Non-zero is
5252
returned if auto-commit is on, 0 if it is off, or &false; if an error
5353
occurs.
5454
</para>
5555
<para>
56-
If <parameter>enable</parameter> is set, this function returns &true; on
56+
If <parameter>enable</parameter> is non-null, this function returns &true; on
5757
success and &false; on failure.
5858
</para>
5959
</refsect1>

0 commit comments

Comments
 (0)