Entry rwlock is no longer needed as concurrency is managed

[openldap] / contrib / ldapc++ / src / StringList.h

diff --git a/contrib/ldapc++/src/StringList.h b/contrib/ldapc++/src/StringList.h
index f51c4fdcf710938676f67dabe2ed241a25a32a06..09fe6754d9c78b71e15b4477584f63f5ea7c4b5c 100644 (file)
--- a/contrib/ldapc++/src/StringList.h
+++ b/contrib/ldapc++/src/StringList.h
@@ -8,25 +8,80 @@
 
 #include <string>
 #include <list>
-typedef list<string> ListType;
+typedef std::list<std::string> ListType;
 
+/**
+ * Container class to store multiple std::string-objects
+ */
 class StringList{
-    typedef ListType::const_iterator const_iterator;
-   
     private:
         ListType m_data;
 
     public:
+       typedef ListType::const_iterator const_iterator;
+   
+        /**
+         * Constructs an empty std::list.
+         */   
         StringList();
+
+        /**
+         * Copy-constructor
+         */
         StringList(const StringList& sl);
+
+        /**
+         * For internal use only
+         *
+         * This constructor is used by the library internally to create a
+         * std::list of std::string from a array for c-Strings (char*)thar was
+         * returned by the C-API
+         */
         StringList(char** values);
+
+        /**
+         * Destructor
+         */
         ~StringList();
     
+        /**
+         * The methods converts the list to a 0-terminated array of
+         * c-Strings.
+         */
         char** toCharArray() const;
-        void add(const string& value);
+  
+        /**
+         * Adds one element to the end of the list.
+         * @param attr The attribute to add to the list.
+         */
+        void add(const std::string& value);
+
+        /**
+         * @return The number of strings that are currently
+         * stored in this list.
+         */
         size_t size() const;
+
+        /**
+         * @return true if there are zero strings currently
+         * stored in this list.
+         */
+        bool empty() const;
+
+        /**
+         * @return A iterator that points to the first element of the list.
+         */
         const_iterator begin() const;
+
+        /**
+         * @return A iterator that points to the element after the last
+         * element of the list.
+         */
         const_iterator end() const;
+
+        /**
+         * removes all elements from the list
+         */
         void clear(); 
 };
 #endif //STRING_LIST_H