]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3106] Fixed some doxygen warnings
authorMarcin Siodelski <marcin@isc.org>
Tue, 28 Nov 2023 12:05:36 +0000 (13:05 +0100)
committerMarcin Siodelski <marcin@isc.org>
Wed, 29 Nov 2023 19:58:55 +0000 (20:58 +0100)
src/hooks/dhcp/high_availability/command_creator.h
src/hooks/dhcp/high_availability/ha_config.h
src/hooks/dhcp/high_availability/ha_impl.h

index c137579dda6b1a30cef498f4fa2800d8cab88dbb..829e81fd15afcf3fa9ff062e52dfb85a6704f2ac 100644 (file)
@@ -61,6 +61,7 @@ public:
     ///
     /// @param server_name name of the server sending the command allowing
     /// for associating the command with the relationship.
+    /// @param server_type type of the DHCP server, i.e. v4 or v6.
     /// @return Pointer to the JSON representation of the command.
     static data::ConstElementPtr
     createHeartbeat(const std::string& server_name,
index fc5ddcced85f92e2c90db0b720537cd43ea8ed8c..18e85200df9f8e5895daf0a5000188c54a26d86a 100644 (file)
@@ -584,13 +584,13 @@ public:
         return (max_rejected_lease_updates_);
     }
 
-    /// @brief Sets the maximum number of clients for which lease updates can fail
+    /// @brief Sets the maximum number of clients for whom the lease updates can fail
     /// due to other than general error.
     ///
     /// The service is terminated when the actual number of rejected clients is equal
     /// or greater that number.
     ///
-    /// @param max_rejected_clients maximum number of distinct clients for which
+    /// @param max_rejected_lease_updates maximum number of distinct clients for which
     /// the lease updates can fail before the server terminates the HA service.
     /// A special value of 0 configures the server to never transition to the
     /// terminated state as a result of the lease updates issues.
index bebf3f420bb156ee0d222c42bc254878b5340384..aabaa7295eb98a8ad36ad7a68a59a332700435d5 100644 (file)
@@ -75,7 +75,7 @@ public:
 
     /// @brief Returns parsed configuration by partner name.
     ///
-    /// @param parameter_name name of a partner belonging to the relationship for
+    /// @param partner_name name of a partner belonging to the relationship for
     /// which the configuration should be retrieved.
     /// @return Configuration for the relationship to which the partner belongs.
     HAConfigPtr getConfig(const std::string& partner_name) const {