From: Razvan Becheriu <razvan@isc.org>
Date: Tue, 20 Oct 2020 17:20:37 +0000 (+0300)
Subject: [#1434] updated doxygen
X-Git-Tag: Kea-1.9.1~37
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=52fa0a062228bf533c79ee2a53ee5591858edfd1;p=thirdparty%2Fkea.git

[#1434] updated doxygen
---

diff --git a/src/lib/dhcpsrv/cql_lease_mgr.h b/src/lib/dhcpsrv/cql_lease_mgr.h
index d96e90734c..61899e1846 100644
--- a/src/lib/dhcpsrv/cql_lease_mgr.h
+++ b/src/lib/dhcpsrv/cql_lease_mgr.h
@@ -411,14 +411,12 @@ public:
     /// @throw isc::db::DbOperationError An operation on the open database has
     ///        failed.
     ///
-    /// @note This function checks that old_cltt_ and old_valid_lft_ values of
-    /// the stored lease match values of the new lease.
-    /// The old_cltt_ and old_valid_lft_ are used to ensure automatic action on
-    /// respective lease.
-    /// @note The UPDATE query uses IF expire = ? to delete the lease only if
+    /// @note The old_cltt_ and old_valid_lft_ are used to ensure that only one
+    /// thread or process performs an update or delete operation on the lease by
+    /// matching these values with the expired data in the database.
+    /// @note The UPDATE query uses IF expire = ? to update the lease only if
     /// the value matches the one received on the SELECT query, effectively
-    /// forcing that no other process or thread updates the lease between SELECT
-    /// and UPDATE.
+    /// enforcing no update on the lease between SELECT and UPDATE.
     virtual void updateLease4(const Lease4Ptr& lease4) override;
 
     /// @brief Updates IPv6 lease.
@@ -433,14 +431,12 @@ public:
     /// @throw isc::db::DbOperationError An operation on the open database has
     ///        failed.
     ///
-    /// @note This function checks that old_cltt_ and old_valid_lft_ values of
-    /// the stored lease match values of the new lease.
-    /// The old_cltt_ and old_valid_lft_ are used to ensure automatic action on
-    /// respective lease.
-    /// @note The UPDATE query uses IF expire = ? to delete the lease only if
+    /// @note The old_cltt_ and old_valid_lft_ are used to ensure that only one
+    /// thread or process performs an update or delete operation on the lease by
+    /// matching these values with the expired data in the database.
+    /// @note The UPDATE query uses IF expire = ? to update the lease only if
     /// the value matches the one received on the SELECT query, effectively
-    /// forcing that no other process or thread updates the lease between SELECT
-    /// and UPDATE.
+    /// enforcing no update on the lease between SELECT and UPDATE.
     virtual void updateLease6(const Lease6Ptr& lease6) override;
 
     /// @brief Deletes an IPv4 lease.
@@ -449,14 +445,12 @@ public:
     ///
     /// @return true if deletion was successful, false if no such lease exists.
     ///
-    /// @note This function checks that old_cltt_ and old_valid_lft_ values of
-    /// the stored lease match values of the new lease.
-    /// The old_cltt_ and old_valid_lft_ are used to ensure automatic action on
-    /// respective lease.
+    /// @note The old_cltt_ and old_valid_lft_ are used to ensure that only one
+    /// thread or process performs an update or delete operation on the lease by
+    /// matching these values with the expired data in the database.
     /// @note The DELETE query uses IF expire = ? to delete the lease only if
     /// the value matches the one received on the SELECT query, effectively
-    /// forcing that no other process or thread updates the lease between SELECT
-    /// and DELETE.
+    /// enforcing no update on the lease between SELECT and DELETE.
     bool deleteLease(const Lease4Ptr& lease) override final;
 
     /// @brief Deletes an IPv6 lease.
@@ -465,14 +459,12 @@ public:
     ///
     /// @return true if deletion was successful, false if no such lease exists.
     ///
-    /// @note This function checks that old_cltt_ and old_valid_lft_ values of
-    /// the stored lease match values of the new lease.
-    /// The old_cltt_ and old_valid_lft_ are used to ensure automatic action on
-    /// respective lease.
+    /// @note The old_cltt_ and old_valid_lft_ are used to ensure that only one
+    /// thread or process performs an update or delete operation on the lease by
+    /// matching these values with the expired data in the database.
     /// @note The DELETE query uses IF expire = ? to delete the lease only if
     /// the value matches the one received on the SELECT query, effectively
-    /// forcing that no other process or thread updates the lease between SELECT
-    /// and DELETE.
+    /// enforcing no update on the lease between SELECT and DELETE.
     bool deleteLease(const Lease6Ptr& lease) override final;
 
     /// @brief Deletes all expired and reclaimed DHCPv4 leases.