From 3c699fad2dd94ee926ba04bdaf79e6f14b5b728b Mon Sep 17 00:00:00 2001
From: Alexander Pas <mail@dropdev.org>
Date: Tue, 21 Sep 2021 13:11:43 +0200
Subject: [PATCH] Fix `mixed` return type declarations and parameters of Misc.
 Functions (#942)

---
 reference/misc/functions/get-browser.xml      | 9 +++++++--
 reference/misc/functions/highlight-file.xml   | 2 +-
 reference/misc/functions/highlight-string.xml | 6 +++---
 3 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/reference/misc/functions/get-browser.xml b/reference/misc/functions/get-browser.xml
index 3991f25045..5f481886cb 100644
--- a/reference/misc/functions/get-browser.xml
+++ b/reference/misc/functions/get-browser.xml
@@ -9,8 +9,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>get_browser</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>user_agent</parameter></methodparam>
+   <type class="union"><type>object</type><type>array</type><type>false</type></type><methodname>get_browser</methodname>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>user_agent</parameter><initializer>&null;</initializer></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>return_array</parameter><initializer>&false;</initializer></methodparam>
   </methodsynopsis>
   <para>
@@ -65,6 +65,11 @@
    cookies are accepted is to set one with <function>setcookie</function>,
    reload, and check for the value.
   </para>
+  <para>
+    Returns &false; when no information can be retrieved, such as when the
+    <link linkend="ini.browscap">browscap</link> configuration setting in 
+    &php.ini; has not been set.
+  </para>
  </refsect1>
 
  <refsect1 role="examples">
diff --git a/reference/misc/functions/highlight-file.xml b/reference/misc/functions/highlight-file.xml
index 8f843c9b85..0cc1bbbaf4 100644
--- a/reference/misc/functions/highlight-file.xml
+++ b/reference/misc/functions/highlight-file.xml
@@ -9,7 +9,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>highlight_file</methodname>
+   <type class="union"><type>string</type><type>bool</type></type><methodname>highlight_file</methodname>
    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>return</parameter><initializer>&false;</initializer></methodparam>
   </methodsynopsis>
diff --git a/reference/misc/functions/highlight-string.xml b/reference/misc/functions/highlight-string.xml
index 62ba359c4b..3c1e4fe107 100644
--- a/reference/misc/functions/highlight-string.xml
+++ b/reference/misc/functions/highlight-string.xml
@@ -9,8 +9,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>highlight_string</methodname>
-   <methodparam><type>string</type><parameter>str</parameter></methodparam>
+   <type class="union"><type>string</type><type>bool</type></type><methodname>highlight_string</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>return</parameter><initializer>&false;</initializer></methodparam>
   </methodsynopsis>
   <simpara>
@@ -24,7 +24,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>str</parameter></term>
+     <term><parameter>string</parameter></term>
      <listitem>
       <para>
        The PHP code to be highlighted. This should include the opening tag.