Added documentation for wxItemContainer class; moved methods docs

[wxWidgets.git] / interface / hashset.h

diff --git a/interface/hashset.h b/interface/hashset.h
index 144db17724266ab74ea87a9ecefb8a8ca4f123ff..1470b29ef03ceaeb3bb0493dcfc6742330eb4b74 100644 (file)
--- a/interface/hashset.h
+++ b/interface/hashset.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        hashset.h
-// Purpose:     documentation for wxHashSet class
+// Purpose:     interface of wxHashSet
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,16 +9,16 @@
 /**
     @class wxHashSet
     @wxheader{hashset.h}
-    
+
     This is a simple, type-safe, and reasonably efficient hash set class,
     whose interface is a subset of the interface of STL containers. In
     particular, the interface is modeled after std::set, and the various,
     non-standard, std::hash_map.
-    
+
     @library{wxbase}
     @category{FIXME}
 */
-class wxHashSet 
+class wxHashSet
 {
 public:
     //@{
@@ -26,7 +26,7 @@ public:
         Copy constructor.
     */
     wxHashSet(size_type size = 10);
-        wxHashSet(const wxHashSet& set);
+    wxHashSet(const wxHashSet& set);
     //@}
 
     //@{
@@ -35,7 +35,7 @@ public:
         Please remember that hash sets do not guarantee ordering.
     */
     const_iterator begin();
-        iterator begin();
+    const iterator begin();
     //@}
 
     /**
@@ -47,12 +47,12 @@ public:
         Counts the number of elements with the given key present in the set.
         This function returns only 0 or 1.
     */
-    size_type count(const key_type& key);
+    size_type count(const key_type& key) const;
 
     /**
         Returns @true if the hash set does not contain any elements, @false otherwise.
     */
-    bool empty();
+    bool empty() const;
 
     //@{
     /**
@@ -60,7 +60,7 @@ public:
         Please remember that hash sets do not guarantee ordering.
     */
     const_iterator end();
-        iterator end();
+    const iterator end();
     //@}
 
     //@{
@@ -69,8 +69,8 @@ public:
         the iterator is no longer valid and must not be used.
     */
     size_type erase(const key_type& key);
-        void erase(iterator it);
-        void erase(const_iterator it);
+    void erase(iterator it);
+    void erase(const_iterator it);
     //@}
 
     //@{
@@ -79,8 +79,8 @@ public:
         an iterator pointing at that element, otherwise an invalid iterator
         is returned (i.e. hashset.find( non_existent_key ) == hashset.end()).
     */
-    iterator find(const key_type& key);
-        const_iterator find(const key_type& key);
+    iterator find(const key_type& key) const;
+    const_iterator find(const key_type& key) const;
     //@}
 
     /**
@@ -94,5 +94,6 @@ public:
     /**
         Returns the number of elements in the set.
     */
-    size_type size();
+    size_type size() const;
 };
+