]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[1040] fixed doxygen
authorRazvan Becheriu <razvan@isc.org>
Fri, 6 Dec 2019 18:14:05 +0000 (20:14 +0200)
committerRazvan Becheriu <razvan@isc.org>
Fri, 10 Jan 2020 15:41:35 +0000 (17:41 +0200)
src/lib/dhcpsrv/lease_mgr.h
src/lib/dhcpsrv/tests/lease_mgr_unittest.cc

index 0b705d242cca09a486b39b89ed8342f41d5ff394..370ac02c3db4c39109e8b709b0ab1757f2711fb8 100644 (file)
@@ -543,21 +543,21 @@ public:
     /// @param lease6 The lease to be updated.
     virtual void updateLease6(const Lease6Ptr& lease6) = 0;
 
-    /// @brief Deletes a lease.
+    /// @brief Deletes an IPv4 lease.
     ///
-    /// @param lease IPv4 lease to be deleted
+    /// @param lease IPv4 lease to be deleted.
     ///
-    /// @return true if deletion was successful, false if no such lease exists
+    /// @return true if deletion was successful, false if no such lease exists.
     ///
     /// @throw isc::dhcp::DbOperationError An operation on the open database has
     ///        failed.
     virtual bool deleteLease(const Lease4Ptr& lease) = 0;
 
-    /// @brief Deletes a lease.
+    /// @brief Deletes an IPv6 lease.
     ///
-    /// @param lease IPv6 lease to be deleted
+    /// @param lease IPv6 lease to be deleted.
     ///
-    /// @return true if deletion was successful, false if no such lease exists
+    /// @return true if deletion was successful, false if no such lease exists.
     ///
     /// @throw isc::db::DbOperationError An operation on the open database has
     ///        failed.
index d93b89adf3adce18203a5a3565d6bc72707b3629..4f35f34d425a107c0f6771476650cd33a1a7a3a0 100644 (file)
@@ -311,20 +311,20 @@ public:
     /// If no such lease is present, an exception will be thrown.
     virtual void updateLease6(const Lease6Ptr&) {}
 
-    /// @brief Deletes a lease.
+    /// @brief Deletes an IPv4 lease.
     ///
-    /// @param lease Lease v4 to be deleted.
+    /// @param lease IPv4 lease to be deleted.
     ///
-    /// @return true if deletion was successful, false if no such lease exists
+    /// @return true if deletion was successful, false if no such lease exists.
     virtual bool deleteLease(const Lease4Ptr&) {
         return (false);
     }
 
-    /// @brief Deletes a lease.
+    /// @brief Deletes an IPv6 lease.
     ///
-    /// @param lease Lease v6 to be deleted.
+    /// @param lease IPv6 lease to be deleted.
     ///
-    /// @return true if deletion was successful, false if no such lease exists
+    /// @return true if deletion was successful, false if no such lease exists.
     virtual bool deleteLease(const Lease6Ptr&) {
         return (false);
     }