Merge remote branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_4

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

diff --git a/contrib/ldapc++/src/LDAPEntryList.h b/contrib/ldapc++/src/LDAPEntryList.h
index b75aed8bca6bf3b6ade87b2cc9f4eabb1ed2c21a..60a6da65d6b9ad2d1bad6d92d672e1e0263b34a0 100644 (file)
--- a/contrib/ldapc++/src/LDAPEntryList.h
+++ b/contrib/ldapc++/src/LDAPEntryList.h
@@ -1,30 +1,70 @@
+// $OpenLDAP$
 /*
- * Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
+ * Copyright 2000-2013 The OpenLDAP Foundation, All Rights Reserved.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  */
 
 #ifndef LDAP_ENTRY_LIST_H
 #define LDAP_ENTRY_LIST_H
 
+#include <cstdio>
 #include <list>
 
 class LDAPEntry;
    
-typedef list<LDAPEntry> EntryList;
+/**
+ * For internal use only.
+ * 
+ * This class is used by LDAPSearchResults to store a std::list of
+ * LDAPEntry-Objects
+ */
 class LDAPEntryList{
-    typedef EntryList::const_iterator const_iterator;
-
-    private:
-        EntryList m_entries;
+    typedef std::list<LDAPEntry> ListType;
 
     public:
+       typedef ListType::const_iterator const_iterator;
+
+        /**
+         * Copy-Constructor
+         */
         LDAPEntryList(const LDAPEntryList& el);
+
+        /**
+         * Default-Constructor
+         */
         LDAPEntryList();
+
+        /**
+         * Destructor
+         */
         ~LDAPEntryList();
 
+        /**
+         * @return The number of entries currently stored in the list.
+         */
         size_t size() const;
+
+        /**
+         * @return true if there are zero entries currently stored in the list.
+         */
+        bool empty() const;
+
+        /**
+         * @return An iterator pointing to the first element of the list.
+         */
         const_iterator begin() const;
+
+        /**
+         * @return An iterator pointing to the end of the list
+         */
         const_iterator end() const;
+
+        /**
+         * Adds an Entry to the end of the list.
+         */
         void addEntry(const LDAPEntry& e);
+
+    private:
+        ListType m_entries;
 };
 #endif // LDAP_ENTRY_LIST_H