diff options
Diffstat (limited to 'doc/classes/Array.xml')
| -rw-r--r-- | doc/classes/Array.xml | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index f833764141..2cfbaffe04 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -104,6 +104,7 @@ <return type="Array"> </return> <description> + Returns a copy of this [code]Array[/code]. </description> </method> <method name="empty"> @@ -177,8 +178,10 @@ </description> </method> <method name="invert"> + <return type="Array"> + </return> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array. </description> </method> <method name="pop_back"> @@ -213,7 +216,7 @@ </description> </method> <method name="resize"> - <argument index="0" name="position" type="int"> + <argument index="0" name="size" type="int"> </argument> <description> Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. @@ -238,17 +241,21 @@ </description> </method> <method name="sort"> + <return type="Array"> + </return> <description> - Sort the array using natural order. + Sort the array using natural order and return reference to the array. </description> </method> <method name="sort_custom"> + <return type="Array"> + </return> <argument index="0" name="obj" type="Object"> </argument> <argument index="1" name="func" type="String"> </argument> <description> - Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. + Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. </description> </method> </methods> |