From 24f68c0854508835b7fd2befcda58a33c3bdbfa5 Mon Sep 17 00:00:00 2001 From: Marcin Siodelski Date: Tue, 28 Nov 2023 13:05:36 +0100 Subject: [PATCH] [#3106] Fixed some doxygen warnings --- src/hooks/dhcp/high_availability/command_creator.h | 1 + src/hooks/dhcp/high_availability/ha_config.h | 4 ++-- src/hooks/dhcp/high_availability/ha_impl.h | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/hooks/dhcp/high_availability/command_creator.h b/src/hooks/dhcp/high_availability/command_creator.h index c137579dda..829e81fd15 100644 --- a/src/hooks/dhcp/high_availability/command_creator.h +++ b/src/hooks/dhcp/high_availability/command_creator.h @@ -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, diff --git a/src/hooks/dhcp/high_availability/ha_config.h b/src/hooks/dhcp/high_availability/ha_config.h index fc5ddcced8..18e85200df 100644 --- a/src/hooks/dhcp/high_availability/ha_config.h +++ b/src/hooks/dhcp/high_availability/ha_config.h @@ -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. diff --git a/src/hooks/dhcp/high_availability/ha_impl.h b/src/hooks/dhcp/high_availability/ha_impl.h index bebf3f420b..aabaa7295e 100644 --- a/src/hooks/dhcp/high_availability/ha_impl.h +++ b/src/hooks/dhcp/high_availability/ha_impl.h @@ -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 {