Minor corrections to sorted arrays documentation.

Mention that Remove() uses binary search for sorted arrays so the item removed
by it is not necessarily the first one. Also correct documentation of Index()
for sorted arrays which was incorrectly the same as for the normal kind.

Closes #11233.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62046 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/dynarray.h b/interface/wx/dynarray.h
index 6001afe7454bd485705d3b8d00ea6d5c6bb21775..43779dc95cb831e1a4c976348bfa0e4e40d87d48 100644 (file)
--- a/interface/wx/dynarray.h
+++ b/interface/wx/dynarray.h
@@ -553,6 +553,10 @@ public:
         See also WX_CLEAR_ARRAY() macro which deletes all elements of a wxArray
         (supposed to contain pointers).
 
         See also WX_CLEAR_ARRAY() macro which deletes all elements of a wxArray
         (supposed to contain pointers).
 

+        Notice that for sorted arrays this method uses binary search to find
+        the item so it doesn't necessarily remove the first matching item, but
+        the first one found by the binary search.
+

         @see RemoveAt()
     */
     void Remove(T item);
         @see RemoveAt()
     */
     void Remove(T item);


@@ -602,8 +606,8 @@ public:
     /**
         This version of Index() is for wxSortedArray only.
 
     /**
         This version of Index() is for wxSortedArray only.
 

-        Searches the element in the array, starting from either beginning or
-        the end depending on the value of @a searchFromEnd parameter.
+        Searches for the element in the array, using binary search.
+

         @c wxNOT_FOUND is returned if the element is not found, otherwise the
         index of the element is returned.
     */
         @c wxNOT_FOUND is returned if the element is not found, otherwise the
         index of the element is returned.
     */