document recently added enums

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

diff --git a/interface/wx/arrstr.h b/interface/wx/arrstr.h
index 7303b4d8f2d4ab7538e7ee37e7d1c0b12bbedac7..228126f769e42627e40491e17b25c3a48aefa89f 100644 (file)
--- a/interface/wx/arrstr.h
+++ b/interface/wx/arrstr.h
@@ -6,13 +6,6 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // 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
 
 /**
     @class wxArrayString
 


@@ -53,11 +46,16 @@
     @library{wxbase}
     @category{containers}
 
     @library{wxbase}
     @category{containers}
 

-    @see wxArray, wxString, @ref overview_string
+    @see wxArray<T>, wxString, @ref overview_string

 */
 class wxArrayString : public wxArray
 {
 public:
 */
 class wxArrayString : public wxArray
 {
 public:

+    /**
+        The function type used with wxArrayString::Sort function.
+    */
+    typedef int (*CompareFunction)(const wxString& first, const wxString& second);
+

     /**
         Default constructor.
     */
     /**
         Default constructor.
     */


@@ -144,8 +142,7 @@ public:
 
         If @a nIndex is equal to GetCount() this function behaves as Add().
     */
 
         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
 
     /**
         Returns @true if the array is empty, @false otherwise. This function returns the


@@ -198,7 +195,7 @@ public:
 
     /**
         Sorts the array using the specified @a compareFunction for item comparison.
 
     /**
         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.
         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.


@@ -305,7 +302,7 @@ public:
               bool bFromEnd = false) const;
 
     /**
               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!
     */
                  could break the order of items and, for example, subsequent calls
                  to Index() would then not work!
     */


@@ -314,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.
                  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.


@@ -329,7 +326,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_string */
+/** @addtogroup group_funcmacro_string */

 //@{
 
 /**
 //@{
 
 /**