Merge remote-tracking branch 'origin/mdb.master'

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

diff --git a/contrib/ldapc++/src/LDAPSearchResult.h b/contrib/ldapc++/src/LDAPSearchResult.h
index 4ee1cfad2efa982c4a54821c60a0bb2733d3982c..4ac13f16082f52aeeb48fb6225a7ce40e8f14444 100644 (file)
--- a/contrib/ldapc++/src/LDAPSearchResult.h
+++ b/contrib/ldapc++/src/LDAPSearchResult.h
@@ -1,5 +1,6 @@
+// $OpenLDAP$
 /*
- * Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
+ * Copyright 2000-2012 The OpenLDAP Foundation, All Rights Reserved.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  */
 
@@ -7,19 +8,38 @@
 #ifndef LDAP_SEARCH_RESULT_H
 #define LDAP_SEARCH_RESULT_H
 
-#include "LDAPMessage.h"
-#include "LDAPEntry.h"
+#include <LDAPMessage.h>
+#include <LDAPEntry.h>
 
 class LDAPRequest;
 
+/**
+ * This class is used to represent the result entries of a
+ * SEARCH-operation.
+ */
 class LDAPSearchResult : public LDAPMsg{
-       public:
-               LDAPSearchResult(const LDAPRequest *req, LDAPMessage *msg);
+    public:
+        /**
+         * Constructor that create an object from the C-API structures
+         */
+        LDAPSearchResult(const LDAPRequest *req, LDAPMessage *msg);
+
+        /**
+         * Copy-Constructor
+         */
         LDAPSearchResult(const LDAPSearchResult& res);
-               virtual ~LDAPSearchResult();
-               const LDAPEntry* getEntry() const;
-       
+
+        /**
+         * The Destructor
+         */
+        virtual ~LDAPSearchResult();
+
+        /**
+         * @returns The entry that has been sent with this result message. 
+         */
+        const LDAPEntry* getEntry() const;
+    
     private:
-               LDAPEntry *entry;
+        LDAPEntry *entry;
 };
 #endif //LDAP_SEARCH_RESULT_H