Entry rwlock is no longer needed as concurrency is managed

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

diff --git a/contrib/ldapc++/src/LDAPReferenceList.h b/contrib/ldapc++/src/LDAPReferenceList.h
index 12b3419ea6216cb9e03c971d31e47b68ed50c390..d528b2d65d5e24492412e9ada739765fdf6dac44 100644 (file)
--- a/contrib/ldapc++/src/LDAPReferenceList.h
+++ b/contrib/ldapc++/src/LDAPReferenceList.h
@@ -10,19 +10,59 @@
 
 class LDAPSearchReference;
 
-typedef list<LDAPSearchReference> RefList;
+typedef std::list<LDAPSearchReference> RefList;
 
+/**
+ * Container class for storing a std::list of Search References
+ *
+ * Used internally only by LDAPSearchResults
+ */
 class LDAPReferenceList{
-    typedef RefList::const_iterator const_iterator;
-
     public:
+       typedef RefList::const_iterator const_iterator;
+
+        /**
+         * Constructs an empty std::list.
+         */   
         LDAPReferenceList();
+
+        /**
+         * Copy-constructor
+         */
         LDAPReferenceList(const LDAPReferenceList& rl);
+
+        /**
+         * Destructor
+         */
         ~LDAPReferenceList();
 
+        /**
+         * @return The number of LDAPSearchReference-objects that are 
+         * currently stored in this list.
+         */
         size_t size() const;
+
+        /**
+         * @return true if there are zero LDAPSearchReference-objects
+         * 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;
+
+        /**
+         * Adds one element to the end of the list.
+         * @param e The LDAPSearchReference to add to the list.
+         */
         void addReference(const LDAPSearchReference& e);
 
     private: