Skip to content

Commit d715365

Browse files
kocsismateGirgias
kocsismate
and
Girgias
authored
Sync some methodsynopses with stubs (#3199)
Co-authored-by: Gina Peter Banyard <girgias@php.net>
1 parent ad7129d commit d715365

14 files changed

Lines changed: 51 additions & 19 deletions

File tree

‎reference/dom/domnode/getrootnode.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
&reftitle.description;
1010
<methodsynopsis role="DOMNode">
1111
<modifier>public</modifier> <type>DOMNode</type><methodname>DOMNode::getRootNode</methodname>
12-
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
12+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
1313
</methodsynopsis>
1414
<para>
1515
Get root node.

‎reference/errorfunc/functions/trigger-error.xml‎

Lines changed: 35 additions & 3 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>trigger_error</methodname>
12+
<type>true</type><methodname>trigger_error</methodname>
1313
<methodparam><type>string</type><parameter>message</parameter></methodparam>
1414
<methodparam choice="opt"><type>int</type><parameter>error_level</parameter><initializer><constant>E_USER_NOTICE</constant></initializer></methodparam>
1515
</methodsynopsis>
@@ -55,11 +55,43 @@
5555
<refsect1 role="returnvalues">
5656
&reftitle.returnvalues;
5757
<para>
58-
This function returns &false; if wrong <parameter>error_level</parameter> is
59-
specified, &true; otherwise.
58+
&return.true.always;
6059
</para>
6160
</refsect1>
6261

62+
<refsect1 role="errors">
63+
&reftitle.errors;
64+
<para>
65+
This function throws a <classname>ValueError</classname> if
66+
<parameter>error_level</parameter> is not one of
67+
<constant>E_USER_ERROR</constant>, <constant>E_USER_WARNING</constant>,
68+
<constant>E_USER_NOTICE</constant>, <constant>E_USER_DEPRECATED</constant>.
69+
</para>
70+
</refsect1>
71+
72+
<refsect1 role="changelog">
73+
&reftitle.changelog;
74+
<informaltable>
75+
<tgroup cols="2">
76+
<thead>
77+
<row>
78+
<entry>&Version;</entry>
79+
<entry>&Description;</entry>
80+
</row>
81+
</thead>
82+
<tbody>
83+
<row>
84+
<entry>8.0.0</entry>
85+
<entry>
86+
The function now throws a <classname>ValueError</classname> if an invalid
87+
<parameter>error_level</parameter> is specified. Previously, it returned &false;.
88+
</entry>
89+
</row>
90+
</tbody>
91+
</tgroup>
92+
</informaltable>
93+
</refsect1>
94+
6395
<refsect1 role="examples">
6496
&reftitle.examples;
6597
<para>

‎reference/intl/intlcalendar/setdatetime.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<methodparam><type>int</type><parameter>dayOfMonth</parameter></methodparam>
1515
<methodparam><type>int</type><parameter>hour</parameter></methodparam>
1616
<methodparam><type>int</type><parameter>minute</parameter></methodparam>
17-
<methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>&null;</initializer></methodparam>
17+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>second</parameter><initializer>&null;</initializer></methodparam>
1818
</methodsynopsis>
1919
<para>
2020
Sets a date and time fields to the given value.

‎reference/intl/intlgregoriancalendar/createfromdate.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis role="IntlGregorianCalendar">
11-
<modifier>public</modifier> <type>static</type><methodname>IntlGregorianCalendar::createFromDate</methodname>
11+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>IntlGregorianCalendar::createFromDate</methodname>
1212
<methodparam><type>int</type><parameter>year</parameter></methodparam>
1313
<methodparam><type>int</type><parameter>month</parameter></methodparam>
1414
<methodparam><type>int</type><parameter>dayOfMonth</parameter></methodparam>

‎reference/intl/intlgregoriancalendar/createfromdatetime.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
<refsect1 role="description">
99
&reftitle.description;
1010
<methodsynopsis role="IntlGregorianCalendar">
11-
<modifier>public</modifier> <type>static</type><methodname>IntlGregorianCalendar::createFromDateTime</methodname>
11+
<modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>IntlGregorianCalendar::createFromDateTime</methodname>
1212
<methodparam><type>int</type><parameter>year</parameter></methodparam>
1313
<methodparam><type>int</type><parameter>month</parameter></methodparam>
1414
<methodparam><type>int</type><parameter>dayOfMonth</parameter></methodparam>
1515
<methodparam><type>int</type><parameter>hour</parameter></methodparam>
1616
<methodparam><type>int</type><parameter>minute</parameter></methodparam>
17-
<methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>&null;</initializer></methodparam>
17+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>second</parameter><initializer>&null;</initializer></methodparam>
1818
</methodsynopsis>
1919
<para>
2020
Creates a new <classname>IntlGregorianCalendar</classname> instance from date and time.

‎reference/json/functions/json-validate.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
<methodsynopsis>
1212
<type>bool</type><methodname>json_validate</methodname>
1313
<methodparam><type>string</type><parameter>json</parameter></methodparam>
14-
<methodparam><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>
15-
<methodparam><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
14+
<methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>
15+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
1616
</methodsynopsis>
1717
<para>
1818
Returns whether the given &string; is syntactically valid JSON.

‎reference/ldap/functions/ldap-connect-wallet.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>uri</parameter><initializer>&null;</initializer></methodparam>
1313
<methodparam><type>string</type><parameter>wallet</parameter></methodparam>
1414
<methodparam><type>string</type><parameter>password</parameter></methodparam>
15-
<methodparam choice="opt"><type>int</type><parameter>auth_mode</parameter><initializer>GSLC_SSL_NO_AUTH</initializer></methodparam>
15+
<methodparam choice="opt"><type>int</type><parameter>auth_mode</parameter><initializer><constant>GSLC_SSL_NO_AUTH</constant></initializer></methodparam>
1616
</methodsynopsis>
1717
<para>
1818

‎reference/network/functions/long2ip.xml‎

Lines changed: 2 additions & 2 deletions
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" xml:id="function.long2ip">
3+
<refentry xml:id="function.long2ip" xmlns="http://docbook.org/ns/docbook">
44
<refnamediv>
55
<refname>long2ip</refname>
66
<refpurpose>Converts a long integer address into a string in (IPv4) Internet standard dotted format</refpurpose>
@@ -9,7 +9,7 @@
99
<refsect1 role="description">
1010
&reftitle.description;
1111
<methodsynopsis>
12-
<type class="union"><type>string</type><type>false</type></type><methodname>long2ip</methodname>
12+
<type>string</type><methodname>long2ip</methodname>
1313
<methodparam><type>int</type><parameter>ip</parameter></methodparam>
1414
</methodsynopsis>
1515
<para>

‎reference/outcontrol/functions/ob-start.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
&reftitle.description;
1111
<methodsynopsis>
1212
<type>bool</type><methodname>ob_start</methodname>
13-
<methodparam choice="opt"><type>callable</type><parameter>callback</parameter><initializer>&null;</initializer></methodparam>
13+
<methodparam choice="opt"><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter><initializer>&null;</initializer></methodparam>
1414
<methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter><initializer>0</initializer></methodparam>
1515
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant></initializer></methodparam>
1616
</methodsynopsis>

‎reference/simplexml/functions/simplexml-import-dom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
&reftitle.description;
1010
<methodsynopsis>
1111
<type class="union"><type>SimpleXMLElement</type><type>null</type></type><methodname>simplexml_import_dom</methodname>
12-
<methodparam><type class="union"><type>SimpleXMLElement</type><type>DOMNode</type></type><parameter>node</parameter></methodparam>
12+
<methodparam><type>object</type><parameter>node</parameter></methodparam>
1313
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>class_name</parameter><initializer>SimpleXMLElement::class</initializer></methodparam>
1414
</methodsynopsis>
1515
<para>

0 commit comments

Comments
 (0)