document recently added enums

[wxWidgets.git] / interface / wx / arrstr.h

diff --git a/interface/wx/arrstr.h b/interface/wx/arrstr.h
index 34652fe1448082316bacb58c84108dd88bf343d7..228126f769e42627e40491e17b25c3a48aefa89f 100644 (file)
--- a/interface/wx/arrstr.h
+++ b/interface/wx/arrstr.h
@@ -6,16 +6,8 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-/**
-    @todo
-    the following functions are not documented; do they need to be?
-    WXDLLIMPEXP_BASE int wxCMPFUNC_CONV wxStringSortAscending(wxString*, wxString*);
-    WXDLLIMPEXP_BASE int wxCMPFUNC_CONV wxStringSortDescending(wxString*, wxString*);
-*/
-
 /**
     @class wxArrayString
-    @wxheader{arrstr.h}
 
     wxArrayString is an efficient container for storing wxString objects.
 
@@ -54,11 +46,16 @@
     @library{wxbase}
     @category{containers}
 
-    @see wxArray, wxString, @ref overview_string
+    @see wxArray<T>, wxString, @ref overview_string
 */
 class wxArrayString : public wxArray
 {
 public:
+    /**
+        The function type used with wxArrayString::Sort function.
+    */
+    typedef int (*CompareFunction)(const wxString& first, const wxString& second);
+
     /**
         Default constructor.
     */
@@ -97,13 +94,10 @@ public:
     size_t Add(const wxString& str, size_t copies = 1);
 
     /**
-        Preallocates enough memory to store @a nCount items. This function may be
-        used to improve array class performance before adding a known number of items
-        consecutively.
-
-        @todo FIX THIS LINK
+        Preallocates enough memory to store @a nCount items.
 
-        @see @ref wxArray::memorymanagement "Dynamic array memory management"
+        This function may be used to improve array class performance before
+        adding a known number of items consecutively.
     */
     void Alloc(size_t nCount);
 
@@ -148,8 +142,7 @@ public:
 
         If @a nIndex is equal to GetCount() this function behaves as Add().
     */
-    void Insert(const wxString& str, size_t nIndex,
-                size_t copies = 1);
+    void Insert(wxString lItem, size_t nIndex, size_t copies = 1);
 
     /**
         Returns @true if the array is empty, @false otherwise. This function returns the
@@ -187,13 +180,10 @@ public:
     void RemoveAt(size_t nIndex, size_t count = 1);
 
     /**
-        Releases the extra memory allocated by the array. This function is useful to
-        minimize the array memory consumption.
-
-        @todo FIX THIS LINK
+        Releases the extra memory allocated by the array.
+        This function is useful to minimize the array memory consumption.
 
-        @see Alloc(), @ref wxArray::memorymanagement "Dynamic array memory
-        management"
+        @see Alloc()
     */
     void Shrink();
 
@@ -205,7 +195,7 @@ public:
 
     /**
         Sorts the array using the specified @a compareFunction for item comparison.
-        @a CompareFunction is defined as a function taking two @e const wxString
+        @a CompareFunction is defined as a function taking two <em>const wxString&</em>
         parameters and returning an @e int value less than, equal to or greater
         than 0 if the first string is less than, equal to or greater than the
         second one.
@@ -263,7 +253,6 @@ public:
 
 /**
     @class wxSortedArrayString
-    @wxheader{arrstr.h}
 
     wxSortedArrayString is an efficient container for storing wxString objects
     which always keeps the string in alphabetical order.
@@ -310,10 +299,10 @@ public:
         the @a bCase and @a bFromEnd parameters.
     */
     int Index(const wxString& sz, bool bCase = true,
-              bool bFromEnd = false);
+              bool bFromEnd = false) const;
 
     /**
-        @warning this function should not be used with sorted arrays because it
+        @warning This function should not be used with sorted arrays because it
                  could break the order of items and, for example, subsequent calls
                  to Index() would then not work!
     */
@@ -322,7 +311,7 @@ public:
 
     //@{
     /**
-        @warning this function should not be used with sorted array because it could
+        @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! Also, sorting a wxSortedArrayString doesn't make
                  sense because its elements are always already sorted.
@@ -337,7 +326,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_string */
+/** @addtogroup group_funcmacro_string */
 //@{
 
 /**