Synchronize manual with stubs for PHP 8.4 - part 2 (#4178)

Author: kocsismate

reference/datetime/dateinterval/createfromdatestring.xml

@@ -10,7 +10,7 @@
   &reftitle.description;
   <para>&style.oop;</para>
   <methodsynopsis role="DateInterval">
-   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>DateInterval</type><type>false</type></type><methodname>DateInterval::createFromDateString</methodname>
+   <modifier>public</modifier> <modifier>static</modifier> <type>DateInterval</type><methodname>DateInterval::createFromDateString</methodname>
    <methodparam><type>string</type><parameter>datetime</parameter></methodparam>
   </methodsynopsis>
   <para>&style.procedural;</para>
@@ -53,7 +53,16 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns a new <classname>DateInterval</classname> instance on success, &return.falseforfailure;.
+   Returns <classname>DateTimeImmutable</classname> on success.
+   &return.falseforfailure.style.procedural;
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Object Oriented API only: If an invalid Date/Time string is passed,
+   <exceptionname>DateMalformedStringException</exceptionname> is thrown.
   </para>
  </refsect1>
 
@@ -68,6 +77,17 @@
      </row>
     </thead>
     <tbody>
+     <row>
+      <entry>8.3.0</entry>
+      <entry>
+       <methodname>DateInterval::createFromDateString</methodname> now throws
+       <exceptionname>DateMalformedStringException</exceptionname> if an
+       invalid string is passed.  Previously, it returned <literal>false</literal>,
+       and a warning was emitted.
+       <function>date_interval_create_from_date_string</function> has not been
+       changed.
+      </entry>
+     </row>
      <row>
       <entry>8.2.0</entry>
       <entry>

reference/datetime/datetime/modify.xml

@@ -11,7 +11,7 @@
   &reftitle.description;
   <para>&style.oop;</para>
   <methodsynopsis role="DateTime">
-   <modifier>public</modifier> <type class="union"><type>DateTime</type><type>false</type></type><methodname>DateTime::modify</methodname>
+   <modifier>public</modifier> <type>DateTime</type><methodname>DateTime::modify</methodname>
    <methodparam><type>string</type><parameter>modifier</parameter></methodparam>
   </methodsynopsis>
   <para>&style.procedural;</para>
@@ -42,14 +42,15 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &date.datetime.return.modifiedobjectorfalseforfailure;
+   Returns <classname>DateTime</classname> on success.
+   &return.falseforfailure.style.procedural;
   </para>
  </refsect1>
 
  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-    Object Orientated API only: If an invalid Date/Time string is passed,
+    Object Oriented API only: If an invalid Date/Time string is passed,
     <exceptionname>DateMalformedStringException</exceptionname> is thrown.
   </para>
  </refsect1>
@@ -68,10 +69,10 @@
      <row>
       <entry>8.3.0</entry>
       <entry>
-       Now throws
-       <exceptionname>DateMalformedStringException</exceptionname> with
-       <methodname>DateTime::modify</methodname> if an invalid string is
-       passed, instead of a warning.
+       <methodname>DateTime::modify</methodname> now throws
+       <exceptionname>DateMalformedStringException</exceptionname> if an
+       invalid string is passed.  Previously, it returned <literal>false</literal>,
+       and a warning was emitted.
        <function>date_modify</function> has not been changed.
       </entry>
      </row>

reference/datetime/datetime/sub.xml

@@ -64,7 +64,7 @@
  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-    Object Orientated API only: If an unsupported operation is attempted, such as using a
+    Object Oriented API only: If an unsupported operation is attempted, such as using a
     <classname>DateInterval</classname> object representing relative time
     specifications such as <literal>next weekday</literal>, a
     <exceptionname>DateInvalidOperationException</exceptionname> is thrown.

reference/datetime/datetimeimmutable/modify.xml

@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="DateTimeImmutable">
-   <modifier>public</modifier> <type class="union"><type>DateTimeImmutable</type><type>false</type></type><methodname>DateTimeImmutable::modify</methodname>
+   <modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::modify</methodname>
    <methodparam><type>string</type><parameter>modifier</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -33,7 +33,8 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns a new modified DateTimeImmutable object&return.falseforfailure;.
+   Returns <classname>DateTimeImmutable</classname> on success.
+   &return.falseforfailure.style.procedural;
   </para>
  </refsect1>
 
@@ -60,9 +61,10 @@
      <row>
       <entry>8.3.0</entry>
       <entry>
-       Now throws
+       <methodname>DateTimeImmutable::modify</methodname> now throws
        <exceptionname>DateMalformedStringException</exceptionname> if an
-       invalid string is passed, instead of a warning.
+       invalid string is passed.  Previously, it returned <literal>false</literal>,
+       and a warning was emitted.
       </entry>
      </row>
     </tbody>

reference/mysqli/mysqli_driver/report-mode.xml

@@ -11,11 +11,11 @@
   &reftitle.description;
   <para>&style.oop;</para>
   <fieldsynopsis>
-   <type>int</type><varname linkend="mysqli-driver.report-mode">mysqli_driver->report_mode</varname>
+   <type>int</type><varname linkend="mysqli-driver.report-mode">mysqli_driver-&gt;report_mode</varname>
   </fieldsynopsis>
   <para>&style.procedural;</para>
   <methodsynopsis>
-   <type>bool</type><methodname>mysqli_report</methodname>
+   <type>true</type><methodname>mysqli_report</methodname>
    <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -83,7 +83,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns &true;.
+   &return.true.always;
   </para>
  </refsect1>
 
@@ -199,7 +199,6 @@ try {
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

reference/phar/Phar/copy.xml

@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="Phar">
-   <modifier>public</modifier> <type>bool</type><methodname>Phar::copy</methodname>
+   <modifier>public</modifier> <type>true</type><methodname>Phar::copy</methodname>
    <methodparam><type>string</type><parameter>from</parameter></methodparam>
    <methodparam><type>string</type><parameter>to</parameter></methodparam>
   </methodsynopsis>
@@ -47,15 +47,14 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   returns &true; on success, but it is safer to encase method call in a
-   try/catch block and assume success if no exception is thrown.
+   &return.true.always;
   </para>
  </refsect1>
 
  <refsect1 role="errors">
   &reftitle.errors;
   <para>
-   throws <classname>UnexpectedValueException</classname> if the source file does not
+   Throws <classname>UnexpectedValueException</classname> if the source file does not
    exist, the destination file already exists, write access is disabled, opening either
    file fails, reading the source file fails, or a <classname>PharException</classname>
    if writing the changes to the phar fails.

reference/phar/Phar/decompressFiles.xml

@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="Phar">
-   <modifier>public</modifier> <type>bool</type><methodname>Phar::decompressFiles</methodname>
+   <modifier>public</modifier> <type>true</type><methodname>Phar::decompressFiles</methodname>
    <void/>
   </methodsynopsis>
   &phar.write;
@@ -40,7 +40,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.success;
+   &return.true.always;
   </para>
  </refsect1>
 

reference/phar/Phar/delMetadata.xml

@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="Phar">
-   <modifier>public</modifier> <type>bool</type><methodname>Phar::delMetadata</methodname>
+   <modifier>public</modifier> <type>true</type><methodname>Phar::delMetadata</methodname>
    <void/>
   </methodsynopsis>
   &phar.write;
@@ -28,8 +28,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   returns &true; on success, but it is better to check for thrown exception,
-   and assume success if none is thrown.
+   &return.true.always;
   </para>
  </refsect1>
 

reference/phar/Phar/delete.xml

@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="Phar">
-   <modifier>public</modifier> <type>bool</type><methodname>Phar::delete</methodname>
+   <modifier>public</modifier> <type>true</type><methodname>Phar::delete</methodname>
    <methodparam><type>string</type><parameter>localName</parameter></methodparam>
   </methodsynopsis>
   &phar.write;
@@ -40,8 +40,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   returns &true; on success, but it is better to check for thrown exception,
-   and assume success if none is thrown.
+   &return.true.always;
   </para>
  </refsect1>
 

reference/phar/Phar/unlinkArchive.xml

@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="Phar">
-   <modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>Phar::unlinkArchive</methodname>
+   <modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>true</type><methodname>Phar::unlinkArchive</methodname>
    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -37,7 +37,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.success;
+   &return.true.always;
   </para>
  </refsect1>