reference/array/functions/uksort.xml
2226ad08fd93e3979efbba47c5ae3545eec97d25
...
...
@@ -8,18 +8,18 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>bool</type><methodname>uksort</methodname>
11
+
<type>true</type><methodname>uksort</methodname>
12
12
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
13
13
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
-
<function>uksort</function> will sort the keys of an array using a
17
-
user-supplied comparison function. If the array you wish to sort
18
-
needs to be sorted by some non-trivial criteria, you should use
19
-
this function.
16
+
Sorts <parameter>array</parameter> in place by keys using a
17
+
user-supplied comparison function to determine the order.
20
18
</para>
21
19
&note.sort-unstable;
20
+
&note.reset-index;
22
21
</refsect1>
22
+

23
23
<refsect1 role="parameters">
24
24
&reftitle.parameters;
25
25
<para>
...
...
@@ -35,21 +35,38 @@
35
35
<varlistentry>
36
36
<term><parameter>callback</parameter></term>
37
37
<listitem>
38
-
<para>
39
-
&return.callbacksort;
40
-
</para>
41
-
&callback.cmp;
38
+
&sort.callback.description;
42
39
</listitem>
43
40
</varlistentry>
44
41
</variablelist>
45
42
</para>
46
43
</refsect1>
44
+

47
45
<refsect1 role="returnvalues">
48
46
&reftitle.returnvalues;
49
47
<para>
50
-
&return.success;
48
+
&return.true.always;
51
49
</para>
52
50
</refsect1>
51
+

52
+
<refsect1 role="changelog">
53
+
&reftitle.changelog;
54
+
<informaltable>
55
+
<tgroup cols="2">
56
+
<thead>
57
+
<row>
58
+
<entry>&Version;</entry>
59
+
<entry>&Description;</entry>
60
+
</row>
61
+
</thead>
62
+
<tbody>
63
+
&return.type.true;
64
+
&array.changelog.by-ref;
65
+
</tbody>
66
+
</tgroup>
67
+
</informaltable>
68
+
</refsect1>
69
+

53
70
<refsect1 role="examples">
54
71
&reftitle.examples;
55
72
<para>
...
...
@@ -87,15 +104,16 @@ John: 1
87
104
</example>
88
105
</para>
89
106
</refsect1>
107
+

90
108
<refsect1 role="seealso">
91
109
&reftitle.seealso;
92
-
<para>
93
-
<simplelist>
94
-
<member><function>usort</function></member>
95
-
<member>&seealso.array.sorting;</member>
96
-
</simplelist>
97
-
</para>
110
+
<simplelist>
111
+
<member><function>usort</function></member>
112
+
<member><function>uasort</function></member>
113
+
<member>&seealso.array.sorting;</member>
114
+
</simplelist>
98
115
</refsect1>
116
+

99
117
</refentry>
100
118
<!-- Keep this comment at the end of the file
101
119
Local variables:
102
120