From: Andrei Pavel <andrei@isc.org>
Date: Wed, 31 Mar 2021 18:12:16 +0000 (+0300)
Subject: [#1789] fix doxygen errors
X-Git-Tag: Kea-1.9.7~103
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3e9a729fc2546e997830e0048fc2166dc8b4e994;p=thirdparty%2Fkea.git

[#1789] fix doxygen errors
---

diff --git a/src/lib/config_backend/base_config_backend_mgr.h b/src/lib/config_backend/base_config_backend_mgr.h
index 5fc3b217df..92d685850e 100644
--- a/src/lib/config_backend/base_config_backend_mgr.h
+++ b/src/lib/config_backend/base_config_backend_mgr.h
@@ -195,9 +195,9 @@ public:
     /// deleted only if it is unusable.
     /// @return false when not removed because it is not found or because it is
     /// still usable (if_unusable is true), true otherwise.
-    bool delBackend(const std::string& db_type, const std::string& access,
+    bool delBackend(const std::string& db_type, const std::string& dbaccess,
                     bool if_unusable) {
-        return (pool_->del(db_type, access, if_unusable));
+        return (pool_->del(db_type, dbaccess, if_unusable));
     }
 
     /// @brief Returns underlying config backend pool.
diff --git a/src/lib/dhcpsrv/host_mgr.h b/src/lib/dhcpsrv/host_mgr.h
index 09fc75fe86..36e6c14200 100644
--- a/src/lib/dhcpsrv/host_mgr.h
+++ b/src/lib/dhcpsrv/host_mgr.h
@@ -634,7 +634,7 @@ public:
 
     /// @brief Sets IO service to be used by the Host Manager.
     ///
-    /// @param IOService object, used for all ASIO operations.
+    /// @param io_service IOService object, used for all ASIO operations.
     static void setIOService(const isc::asiolink::IOServicePtr& io_service) {
         io_service_ = io_service;
     }
diff --git a/src/lib/dhcpsrv/lease_mgr.h b/src/lib/dhcpsrv/lease_mgr.h
index cd69fda844..261780d375 100644
--- a/src/lib/dhcpsrv/lease_mgr.h
+++ b/src/lib/dhcpsrv/lease_mgr.h
@@ -749,7 +749,7 @@ public:
 
     /// @brief Sets IO service to be used by the Lease Manager.
     ///
-    /// @param IOService object, used for all ASIO operations.
+    /// @param io_service IOService object, used for all ASIO operations.
     static void setIOService(const isc::asiolink::IOServicePtr& io_service) {
         io_service_ = io_service;
     }
diff --git a/src/lib/dhcpsrv/ncr_generator.h b/src/lib/dhcpsrv/ncr_generator.h
index 5f07939992..c8eba6e12d 100644
--- a/src/lib/dhcpsrv/ncr_generator.h
+++ b/src/lib/dhcpsrv/ncr_generator.h
@@ -44,12 +44,12 @@ void queueNCR(const dhcp_ddns::NameChangeType& chg_type, const Lease6Ptr& lease)
 /// @brief Calculates TTL for a DNS resource record based on lease life time.
 ///
 /// Per RFC 4702 Section 5, the RR TTL should be calculated as:
-/// TTL = ((lease life time / 3)  < 10 minutes) ? 10 minutes : (lease life time / 3) 
+/// TTL = ((lease life time / 3)  < 10 minutes) ? 10 minutes : (lease life time / 3)
 ///
 /// This function may be expanded in the future to support configurable
 /// parameters.
 ///
-/// @param valid_lft valid life time of the lease
+/// @param lease_life_time valid life time of the lease
 ///
 /// @return the calculated TTL.
 uint32_t calculateDdnsTtl(uint32_t lease_life_time);
diff --git a/src/lib/dhcpsrv/network_state.cc b/src/lib/dhcpsrv/network_state.cc
index 61199ab781..6f8db2694d 100644
--- a/src/lib/dhcpsrv/network_state.cc
+++ b/src/lib/dhcpsrv/network_state.cc
@@ -45,7 +45,7 @@ public:
     /// @brief Sets appropriate disabled or enabled DHCP service state for the
     /// respective origin.
     ///
-    /// @node If any of the user commands, HA internal commands or connection
+    /// @note If any of the user commands, HA internal commands or connection
     /// recovery processes disable the dhcp service, the service will remain
     /// disabled until all flags are cleared.
     /// In the case of the connection recovery a reference count is used
diff --git a/src/lib/dhcpsrv/network_state.h b/src/lib/dhcpsrv/network_state.h
index f46afa27e9..3bfc5a1702 100644
--- a/src/lib/dhcpsrv/network_state.h
+++ b/src/lib/dhcpsrv/network_state.h
@@ -100,7 +100,7 @@ public:
 
     /// @brief Disable the DHCP service state for respective transition origin.
     ///
-    /// @node If any of the user commands, HA internal commands or connection
+    /// @note If any of the user commands, HA internal commands or connection
     /// recovery processes disable the dhcp service, the service will remain
     /// disabled until all flags are cleared.
     ///
@@ -109,7 +109,7 @@ public:
 
     /// @brief Enable the DHCP service state for respective transition origin.
     ///
-    /// @node If any of the user commands, HA internal commands or connection
+    /// @note If any of the user commands, HA internal commands or connection
     /// recovery processes disable the dhcp service, the service will remain
     /// disabled until all flags are cleared.
     ///
@@ -121,7 +121,7 @@ public:
     /// Reset internal counters for a specific 'origin' after the server has
     /// been reconfigured or all the connections have been restored.
     ///
-    /// @param origin The origin for which the state flags need to be reset.
+    /// @param type The origin for which the state flags need to be reset.
     void reset(const NetworkState::Origin& type);
 
     /// @brief Enables DHCP service globally and for scopes which have been