From: Tomek Mrugalski <tomasz@isc.org>
Date: Mon, 24 Apr 2017 17:56:47 +0000 (+0200)
Subject: [5208a] return comments updated
X-Git-Tag: trac5212_base~10^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=313d980ed0062777d778aa0d099c9c1c6d2ba0b4;p=thirdparty%2Fkea.git

[5208a] return comments updated
---

diff --git a/src/lib/dhcpsrv/base_host_data_source.h b/src/lib/dhcpsrv/base_host_data_source.h
index 922c17aa95..3dd7f2e312 100644
--- a/src/lib/dhcpsrv/base_host_data_source.h
+++ b/src/lib/dhcpsrv/base_host_data_source.h
@@ -253,7 +253,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del(const SubnetID& subnet_id, const asiolink::IOAddress& addr) = 0;
 
     /// @brief Attempts to delete a host by (subnet-id4, identifier, identifier-type)
@@ -265,7 +266,8 @@ public:
     /// @param identifier_begin Pointer to a beginning of a buffer containing
     /// an identifier.
     /// @param identifier_len Identifier length.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del4(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len) = 0;
@@ -279,12 +281,12 @@ public:
     /// @param identifier_begin Pointer to a beginning of a buffer containing
     /// an identifier.
     /// @param identifier_len Identifier length.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del6(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len) = 0;
 
-
     /// @brief Return backend type
     ///
     /// Returns the type of the backend (e.g. "mysql", "memfile" etc.)
diff --git a/src/lib/dhcpsrv/mysql_host_data_source.h b/src/lib/dhcpsrv/mysql_host_data_source.h
index f053827d98..854f4b968a 100644
--- a/src/lib/dhcpsrv/mysql_host_data_source.h
+++ b/src/lib/dhcpsrv/mysql_host_data_source.h
@@ -226,7 +226,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del(const SubnetID& subnet_id, const asiolink::IOAddress& addr);
 
     /// @brief Attempts to delete a host by (subnet4-id, identifier type, identifier)
@@ -235,7 +236,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del4(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len);
@@ -246,7 +248,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del6(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len);
diff --git a/src/lib/dhcpsrv/pgsql_host_data_source.h b/src/lib/dhcpsrv/pgsql_host_data_source.h
index cfed1ca5f5..c5f4253f6d 100644
--- a/src/lib/dhcpsrv/pgsql_host_data_source.h
+++ b/src/lib/dhcpsrv/pgsql_host_data_source.h
@@ -257,7 +257,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del(const SubnetID& subnet_id, const asiolink::IOAddress& addr);
 
     /// @brief Attempts to delete a host by (subnet4-id, identifier type, identifier)
@@ -266,7 +267,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del4(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len);
@@ -277,7 +279,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del6(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len);