Added the function and macro group pages for Doxygen.

[wxWidgets.git] / interface / vector.h

diff --git a/interface/vector.h b/interface/vector.h
index 26b4ede8e1a3fd18974267397e0ff94f3e3f0b0b..a32f018b73eb032fbcdaab58db568e37348177e9 100644 (file)
--- a/interface/vector.h
+++ b/interface/vector.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        vector.h
-// Purpose:     documentation for wxVector<T> class
+// Purpose:     interface of wxVector<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -21,9 +21,7 @@
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    @ref overview_wxcontaineroverview "Container classes overview", wxListT,
-    wxArrayT
+    @see @ref overview_wxcontaineroverview, wxListT(), wxArrayT()
 */
 class wxVector<T>
 {
@@ -46,7 +44,7 @@ public:
         Returns item at position @e idx.
     */
     const value_type at(size_type idx);
-    value_type at(size_type idx);
+    const value_type at(size_type idx);
     //@}
 
     //@{
@@ -54,7 +52,7 @@ public:
         Return last item.
     */
     const value_type back();
-    value_type back();
+    const value_type back();
     //@}
 
     //@{
@@ -62,13 +60,13 @@ public:
         Return iterator to beginning of the vector.
     */
     const_iterator begin();
-    iterator begin();
+    const iterator begin();
     //@}
 
     /**
         
     */
-    size_type capacity();
+    size_type capacity() const;
 
     /**
         Clears the vector.
@@ -78,14 +76,14 @@ public:
     /**
         Returns @true if the vector is empty.
     */
-    bool empty();
+    bool empty() const;
 
     //@{
     /**
         Returns iterator to the end of the vector.
     */
     const_iterator end();
-    iterator end();
+    const iterator end();
     //@}
 
     //@{
@@ -103,12 +101,11 @@ public:
         Returns first item.
     */
     const value_type front();
-    value_type front();
+    const value_type front();
     //@}
 
     /**
         )
-        
         Insert an item. When using values other than built-in integrals
         or classes with reference counting this can be an inefficient
         operation.
@@ -125,7 +122,7 @@ public:
         Returns item at position @e idx.
     */
     const value_type operator[](size_type idx);
-    value_type operator[](size_type idx);
+    const value_type operator[](size_type idx);
     //@}
 
     /**
@@ -139,9 +136,10 @@ public:
     void push_back(const value_type& v);
 
     /**
-        Reserves more memory of @e n is greater then
+        Reserves more memory of @a n is greater then
         wxVector::size. Other this call has
         no effect.
     */
     void reserve(size_type n);
 };
+