X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4050e98de9c43a9fa60dffb35202d89d749ba081..232b2162776e08c0b16d5280b90f5c075f38c667:/interface/wx/dynarray.h

diff --git a/interface/wx/dynarray.h b/interface/wx/dynarray.h
index 54e1f22f73..4046bc5230 100644
--- a/interface/wx/dynarray.h
+++ b/interface/wx/dynarray.h
@@ -197,6 +197,18 @@
     - WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT()
 
 
+    @section array_predef Predefined array types
+
+    wxWidgets defines the following dynamic array types:
+    - wxArrayShort
+    - wxArrayInt
+    - wxArrayDouble
+    - wxArrayLong
+    - wxArrayPtrVoid
+
+    To use them you don't need any macro; you just need to include @c dynarray.h.
+
+
     @library{wxbase}
     @category{containers}
 
@@ -224,10 +236,12 @@ public:
         Default constructor.
     */
     wxArray();
+
     /**
         Default constructor initializes an empty array object.
     */
     wxObjArray();
+
     /**
         There is no default constructor for wxSortedArray classes - you must
         initialize it with a function to use for item comparison. It is a
@@ -243,11 +257,13 @@ public:
         even if the source array contains the items of pointer type).
     */
     wxArray(const wxArray& array);
+
     /**
         Performs a shallow array copy (i.e. doesn't copy the objects pointed to
         even if the source array contains the items of pointer type).
     */
     wxSortedArray(const wxSortedArray& array);
+
     /**
         Performs a deep copy (i.e. the array element are copied too).
     */
@@ -258,11 +274,13 @@ public:
         even if the source array contains the items of pointer type).
     */
     wxArray& operator=(const wxArray& array);
+
     /**
         Performs a shallow array copy (i.e. doesn't copy the objects pointed to
         even if the source array contains the items of pointer type).
     */
     wxSortedArray& operator=(const wxSortedArray& array);
+
     /**
         Performs a deep copy (i.e. the array element are copied too).
     */
@@ -273,11 +291,13 @@ public:
         may use the WX_CLEAR_ARRAY() macro for this.
     */
     ~wxArray();
+
     /**
         This destructor does not delete all the items owned by the array, you
         may use the WX_CLEAR_ARRAY() macro for this.
     */
     ~wxSortedArray();
+
     /**
         This destructor deletes all the items owned by the array.
     */
@@ -384,6 +404,7 @@ public:
         a lot of items.
     */
     void Add(T item, size_t copies = 1);
+
     /**
         Appends the @a item to the array consisting of the elements of type
         @c T.
@@ -392,6 +413,7 @@ public:
         @a item is stored.
     */
     size_t Add(T item);
+
     /**
         Appends the @a item to the array consisting of the elements of type
         @c T.
@@ -407,6 +429,7 @@ public:
         a lot of items.
     */
     void Add(T* item);
+
     /**
         Appends the given number of @a copies of the @a item to the array
         consisting of the elements of type @c T.
@@ -445,6 +468,7 @@ public:
         overloaded versions of this function.
     */
     void Insert(T item, size_t n, size_t copies = 1);
+
     /**
         Insert the @a item into the array before the existing item @a n - thus,
         @e Insert(something, 0u) will insert an item in such way that it will
@@ -457,6 +481,7 @@ public:
         overloaded versions of this function.
     */
     void Insert(T* item, size_t n);
+
     /**
         Insert the given number of @a copies of the @a item into the array
         before the existing item @a n - thus, @e Insert(something, 0u) will
@@ -619,17 +644,17 @@ public:
 
 
 /**
-    This macro may be used to append all elements of the @a other array to the
-    @a array. The two arrays must be of the same type.
+    This macro may be used to append all elements of the @a wxArray_arrayToBeAppended
+    array to the @a wxArray_arrayToModify. The two arrays must be of the same type.
 */
-#define WX_APPEND_ARRAY(wxArray& array, wxArray& other)
+#define WX_APPEND_ARRAY(wxArray_arrayToModify, wxArray_arrayToBeAppended)
 
 /**
     This macro may be used to delete all elements of the array before emptying
     it. It can not be used with wxObjArrays - but they will delete their
     elements anyway when you call Empty().
 */
-#define WX_CLEAR_ARRAY(wxArray& array)
+#define WX_CLEAR_ARRAY(wxArray_arrayToBeCleared)
 
 //@{
 /**
@@ -764,8 +789,8 @@ public:
 //@}
 
 /**
-    This macro may be used to prepend all elements of the @a other array to the
-    @a array. The two arrays must be of the same type.
+    This macro may be used to prepend all elements of the @a wxArray_arrayToBePrepended
+    array to the @a wxArray_arrayToModify. The two arrays must be of the same type.
 */
-#define WX_PREPEND_ARRAY(wxArray& array, wxArray& other)
+#define WX_PREPEND_ARRAY(wxArray_arrayToModify, wxArray_arrayToBePrepended)