some more comments about wxSortedArrayString::Sort

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

diff --git a/interface/arrstr.h b/interface/arrstr.h
index ab16a2dbcb9d026656b82cc891bcea445d1756b9..a5c24c349369cac84c8cd668b1748e49c5142e8b 100644 (file)
--- a/interface/arrstr.h
+++ b/interface/arrstr.h
@@ -321,19 +321,16 @@ public:
     void Insert(const wxString& str, size_t nIndex,
                 size_t copies = 1);
 
     void Insert(const wxString& str, size_t nIndex,
                 size_t copies = 1);
 

+    //@{

     /**
         @warning this function should not be used with sorted array because it could
                  break the order of items and, for example, subsequent calls to Index()
     /**
         @warning this function should not be used with sorted array because it could
                  break the order of items and, for example, subsequent calls to Index()

-                 would then not work!
+                 would then not work! Also, sorting a wxSortedArrayString doesn't make
+                 sense because its elements are always already sorted.

     */
     void Sort(bool reverseOrder = false);
     */
     void Sort(bool reverseOrder = false);

-
-    /**
-        @warning this function should not be used with sorted array because
-                 it could break the order of items and, for example, subsequent
-                 calls to Index() would then not work!
-    */

     void Sort(CompareFunction compareFunction);
     void Sort(CompareFunction compareFunction);

+    //@}

 };
 
 
 };