Fix return type for 5 misc functions: bool -> true (#380)

2026-03-23 23:12:09 +01:00 · 2026-03-03 11:27:04 +01:00
parent 74f6679282
commit ec1745fef4
5 changed files with 83 additions and 23 deletions
--- a/reference/array/functions/array-multisort.xml
+++ b/reference/array/functions/array-multisort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- EN-Revision: 2e60c5134e7a847c99f81eb3f7ecee1f5efeeace Maintainer: PhilDaiguille Status: ready -->
+<!-- EN-Revision: 5b7646656eb183ea568b8261d6d87a10a1b961c7 Maintainer: PhilDaiguille Status: ready -->
 <!-- Reviewed: no -->
 <!-- CREDITS: DavidA. -->

@@ -11,7 +11,7 @@
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
-   <type>bool</type><methodname>array_multisort</methodname>
+   <type>true</type><methodname>array_multisort</methodname>
   <methodparam><type>array</type><parameter role="reference">array1</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>array1_sort_order</parameter><initializer>SORT_ASC</initializer></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>array1_sort_flags</parameter><initializer>SORT_REGULAR</initializer></methodparam>
@@ -121,10 +121,32 @@
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
-   &return.success;
+   &return.true.always;
  </para>
 </refsect1>

+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.5.0</entry>
+      <entry>
+       El tipo de retorno es ahora &true;; anteriormente, era <type>bool</type>.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
--- a/reference/fileinfo/functions/finfo-close.xml
+++ b/reference/fileinfo/functions/finfo-close.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- EN-Revision: 34bd6f08bdcdd134daa18d2d61b71b9046a87a1a Maintainer: PhilDaiguille Status: ready -->
+<!-- EN-Revision: 5b7646656eb183ea568b8261d6d87a10a1b961c7 Maintainer: PhilDaiguille Status: ready -->
 <!-- Reviewed: no Maintainer: Marqitos -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.finfo-close">
 <refnamediv>
@@ -13,7 +13,7 @@
  &reftitle.description;
  <methodsynopsis>
   <modifier role="attribute">#[\Deprecated]</modifier>
-   <type>bool</type><methodname>finfo_close</methodname>
+   <type>true</type><methodname>finfo_close</methodname>
   <methodparam><type>finfo</type><parameter>finfo</parameter></methodparam>
  </methodsynopsis>

@@ -36,7 +36,7 @@
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
-   &return.success;
+   &return.true.always;
  </simpara>
 </refsect1>

@@ -57,6 +57,12 @@
       Esta función ha sido declarada obsoleta.
      </entry>
     </row>
+     <row>
+      <entry>8.5.0</entry>
+      <entry>
+       El tipo de retorno es ahora &true;; anteriormente, era <type>bool</type>.
+      </entry>
+     </row>
     <row>
      <entry>8.1.0</entry>
      <entry>
--- a/reference/ftp/functions/ftp-set-option.xml
+++ b/reference/ftp/functions/ftp-set-option.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: PhilDaiguille Status: ready -->
+<!-- EN-Revision: 5b7646656eb183ea568b8261d6d87a10a1b961c7 Maintainer: PhilDaiguille Status: ready -->
 <!-- Reviewed: no -->
 <refentry xml:id="function.ftp-set-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
@@ -9,7 +9,7 @@
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
-   <type>bool</type><methodname>ftp_set_option</methodname>
+   <type>true</type><methodname>ftp_set_option</methodname>
   <methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type class="union"><type>int</type><type>bool</type></type><parameter>value</parameter></methodparam>
@@ -84,6 +84,13 @@
  </para>
 </refsect1>

+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.true.always;
+  </para>
+ </refsect1>
+
 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
@@ -95,21 +102,18 @@
     </row>
    </thead>
    <tbody>
+     <row>
+      <entry>8.5.0</entry>
+      <entry>
+       El tipo de retorno es ahora &true;; anteriormente, era <type>bool</type>.
+      </entry>
+     </row>
     &ftp.changelog.ftp-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   Devuelve &true; si la opción pudo ser modificada, &false; en caso contrario. Un mensaje
-   de alerta será enviado si <parameter>option</parameter> no es soportada
-   o bien si el valor <parameter>value</parameter> no corresponde al valor esperado para la
-   opción <parameter>option</parameter> dada.
-  </para>
- </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
--- a/reference/libxml/functions/libxml-set-external-entity-loader.xml
+++ b/reference/libxml/functions/libxml-set-external-entity-loader.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 8109567de77d72f9def7d39d92717248f9100a0b Maintainer: PhilDaiguille Status: ready -->
+<!-- EN-Revision: 5b7646656eb183ea568b8261d6d87a10a1b961c7 Maintainer: PhilDaiguille Status: ready -->
 <!-- Reviewed: no -->
 <refentry xml:id="function.libxml-set-external-entity-loader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
@@ -11,7 +11,7 @@
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
-   <type>bool</type><methodname>libxml_set_external_entity_loader</methodname>
+   <type>true</type><methodname>libxml_set_external_entity_loader</methodname>
   <methodparam><type class="union"><type>callable</type><type>null</type></type><parameter>resolver_function</parameter></methodparam>
  </methodsynopsis>
  <para>
@@ -75,10 +75,32 @@
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
-   &return.success;
+   &return.true.always;
  </para>
 </refsect1>

+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.5.0</entry>
+      <entry>
+       El tipo de retorno es ahora &true;; anteriormente, era <type>bool</type>.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
--- a/reference/sem/functions/shm-detach.xml
+++ b/reference/sem/functions/shm-detach.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: fd2f14b2e44fbda6dd3f94a1d07f2bc9a7567aff Maintainer: PhilDaiguille Status: ready -->
+<!-- EN-Revision: 5b7646656eb183ea568b8261d6d87a10a1b961c7 Maintainer: PhilDaiguille Status: ready -->
 <!-- Reviewed: yes -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-detach">
 <refnamediv>
@@ -11,7 +11,7 @@
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
-   <type>bool</type><methodname>shm_detach</methodname>
+   <type>true</type><methodname>shm_detach</methodname>
   <methodparam><type>SysvSharedMemory</type><parameter>shm</parameter></methodparam>
  </methodsynopsis>
  <simpara>
@@ -41,7 +41,7 @@
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
-   &return.success;
+   &return.true.always;
  </simpara>
 </refsect1>

@@ -56,6 +56,12 @@
     </row>
    </thead>
    <tbody>
+     <row>
+      <entry>8.5.0</entry>
+      <entry>
+       El tipo de retorno es ahora &true;; anteriormente, era <type>bool</type>.
+      </entry>
+     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>