From 313b98ba940827b8fa434129ce90686c8e3fc3e4 Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Fri, 26 Dec 2003 09:56:59 +0000
Subject: [PATCH] sort functions return true or false

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@147340 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/array/functions/arsort.xml | 7 +++++--
 reference/array/functions/asort.xml  | 7 +++++--
 reference/array/functions/krsort.xml | 7 +++++--
 reference/array/functions/ksort.xml  | 7 +++++--
 reference/array/functions/rsort.xml  | 7 +++++--
 reference/array/functions/sort.xml   | 7 +++++--
 reference/array/functions/uasort.xml | 7 +++++--
 reference/array/functions/uksort.xml | 7 +++++--
 reference/array/functions/usort.xml  | 7 +++++--
 9 files changed, 45 insertions(+), 18 deletions(-)

diff --git a/reference/array/functions/arsort.xml b/reference/array/functions/arsort.xml
index 8e47239387..85a02a11b7 100644
--- a/reference/array/functions/arsort.xml
+++ b/reference/array/functions/arsort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.arsort">
    <refnamediv>
@@ -11,7 +11,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>arsort</methodname>
+      <type>bool</type><methodname>arsort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam>
      </methodsynopsis>
@@ -21,6 +21,9 @@
      with.  This is used mainly when sorting associative arrays where
      the actual element order is significant.
     </para>
+    <para>
+     &return.success;
+    </para>
     <example>
      <title><function>arsort</function> example</title>
      <programlisting role="php">
diff --git a/reference/array/functions/asort.xml b/reference/array/functions/asort.xml
index f7f844a890..450e08f891 100644
--- a/reference/array/functions/asort.xml
+++ b/reference/array/functions/asort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.asort">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>asort</methodname>
+      <type>bool</type><methodname>asort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam>
      </methodsynopsis>
@@ -19,6 +19,9 @@
      with.  This is used mainly when sorting associative arrays where
      the actual element order is significant.
     </para>
+    <para>
+     &return.success;
+    </para>
     <example>
      <title><function>asort</function> example</title>
      <programlisting role="php">
diff --git a/reference/array/functions/krsort.xml b/reference/array/functions/krsort.xml
index 2bec20533e..19efd97927 100644
--- a/reference/array/functions/krsort.xml
+++ b/reference/array/functions/krsort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.krsort">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>krsort</methodname>
+      <type>bool</type><methodname>krsort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam>
      </methodsynopsis>
@@ -17,6 +17,9 @@
      Sorts an array by key in reverse order, maintaining key to data
      correlations. This is useful mainly for associative arrays.
     </para>
+    <para>
+     &return.success;
+    </para>
     <para>
      <example>
       <title><function>krsort</function> example</title>
diff --git a/reference/array/functions/ksort.xml b/reference/array/functions/ksort.xml
index a5eba2b242..11c2653e2e 100644
--- a/reference/array/functions/ksort.xml
+++ b/reference/array/functions/ksort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.ksort">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ksort</methodname>
+      <type>bool</type><methodname>ksort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam>
      </methodsynopsis>
@@ -17,6 +17,9 @@
      Sorts an array by key, maintaining key to data correlations. This
      is useful mainly for associative arrays.
     </para>
+    <para>
+     &return.success;
+    </para>
     <para>
      <example>
       <title><function>ksort</function> example</title>
diff --git a/reference/array/functions/rsort.xml b/reference/array/functions/rsort.xml
index 84cc7872f5..7668b785e1 100644
--- a/reference/array/functions/rsort.xml
+++ b/reference/array/functions/rsort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.rsort">
    <refnamediv>
@@ -9,13 +9,16 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>rsort</methodname>
+      <type>bool</type><methodname>rsort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam>
      </methodsynopsis>
     <para>
      This function sorts an array in reverse order (highest to lowest).
     </para>
+    <para>
+     &return.success;
+    </para>
     <para>
      <example>
       <title><function>rsort</function> example</title>
diff --git a/reference/array/functions/sort.xml b/reference/array/functions/sort.xml
index 053391d9cd..34b57604be 100644
--- a/reference/array/functions/sort.xml
+++ b/reference/array/functions/sort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.sort">
    <refnamediv>
@@ -9,7 +9,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>sort</methodname>
+      <type>bool</type><methodname>sort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam>
      </methodsynopsis>
@@ -17,6 +17,9 @@
      This function sorts an array.  Elements will be arranged from
      lowest to highest when this function has completed.
     </para>
+    <para>
+     &return.success;
+    </para>
     <para>
      <example>
       <title><function>sort</function> example</title>
diff --git a/reference/array/functions/uasort.xml b/reference/array/functions/uasort.xml
index ddea369680..e12d375952 100644
--- a/reference/array/functions/uasort.xml
+++ b/reference/array/functions/uasort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.uasort">
    <refnamediv>
@@ -12,7 +12,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>uasort</methodname>
+      <type>bool</type><methodname>uasort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam><type>callback</type><parameter>cmp_function</parameter></methodparam>
      </methodsynopsis>
@@ -23,6 +23,9 @@
      the actual element order is significant.  The comparison function
      is user-defined.
     </para>
+    <para>
+     &return.success;
+    </para>
     <note>
      <para>
       Please see <function>usort</function> and
diff --git a/reference/array/functions/uksort.xml b/reference/array/functions/uksort.xml
index a7f36b09ef..d215d13e17 100644
--- a/reference/array/functions/uksort.xml
+++ b/reference/array/functions/uksort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.uksort">
    <refnamediv>
@@ -11,7 +11,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>uksort</methodname>
+      <type>bool</type><methodname>uksort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam><type>callback</type><parameter>cmp_function</parameter></methodparam>
      </methodsynopsis>
@@ -29,6 +29,9 @@
      be respectively less than, equal to, or greater than the
      second.
     </para>
+    <para>
+     &return.success;
+    </para>
     <para>
      <example>
       <title><function>uksort</function> example</title>
diff --git a/reference/array/functions/usort.xml b/reference/array/functions/usort.xml
index e028046989..4ffc3d987a 100644
--- a/reference/array/functions/usort.xml
+++ b/reference/array/functions/usort.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.15 $ -->
+<!-- $Revision: 1.16 $ -->
 <!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
   <refentry id="function.usort">
    <refnamediv>
@@ -11,7 +11,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>usort</methodname>
+      <type>bool</type><methodname>usort</methodname>
       <methodparam><type>array</type><parameter>array</parameter></methodparam>
       <methodparam><type>callback</type><parameter>cmp_function</parameter></methodparam>
      </methodsynopsis>
@@ -37,6 +37,9 @@
       </para>
      </note>
     </para>
+    <para>
+     &return.success;
+    </para>
     <para>
      <example>
       <title><function>usort</function> example</title>