From: Thomas Markwalder <tmark@isc.org>
Date: Wed, 14 Apr 2021 11:22:38 +0000 (-0400)
Subject: [#1735] Additional review comments
X-Git-Tag: Kea-1.9.7~69
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e6354ef4f805c697302c7fa957e66a8fbe5e295d;p=thirdparty%2Fkea.git

[#1735] Additional review comments

More cosmetics, doxygen fixes.
---

diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index daf8c9657d..8ac3f896d9 100644
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -1453,7 +1453,7 @@ capability:
 
 -  ``enable-multi-threading`` - enables or disables HA+MT
 
--  ``http-dedicated-listener`` - enables or disabled the creation of a dedicated HTTP
+-  ``http-dedicated-listener`` - enables or disables the creation of a dedicated HTTP
    listener the server will use to receive HA messages from its peers.
 
 -  ``http-listener-threads`` - maximum number of threads the dedicated listener
diff --git a/src/hooks/dhcp/high_availability/ha_config.h b/src/hooks/dhcp/high_availability/ha_config.h
index fede5a90f6..b730b80f29 100644
--- a/src/hooks/dhcp/high_availability/ha_config.h
+++ b/src/hooks/dhcp/high_availability/ha_config.h
@@ -526,7 +526,7 @@ public:
 
     /// @brief Sets whether or not server is configured for multi-threaded operation.
     ///
-    /// @param http_enabled boolean flag that enables multi-threaded operation
+    /// @param enable_multi_threading boolean flag that enables multi-threaded operation
     /// when true.
     void setEnableMultiThreading(bool enable_multi_threading) {
         enable_multi_threading_ = enable_multi_threading;
@@ -561,12 +561,12 @@ public:
 
     /// @brief Sets the number of threads the HTTP listener should use.
     ///
-    /// @return number of threads the listener should use.
+    /// @param http_listener_threads number of threads the listener should use.
     void setHttpListenerThreads(uint32_t http_listener_threads) {
         http_listener_threads_ = http_listener_threads;
     }
 
-    /// @brief Fetches the number of threads the HTTP Client should use.
+    /// @brief Fetches the number of threads the HTTP client should use.
     ///
     /// @return number of threads the client is configured to use.
     uint32_t getHttpClientThreads() {
@@ -575,7 +575,7 @@ public:
 
     /// @brief Sets the number of threads the HTTP client should use.
     ///
-    /// @return number of threads the client should use.
+    /// @param http_client_threads number of threads the client should use.
     void setHttpClientThreads(uint32_t http_client_threads) {
         http_client_threads_ = http_client_threads;
     }