2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-30 21:45:37 +00:00

[#3106] Fixed some doxygen warnings

This commit is contained in:
Marcin Siodelski
2023-11-28 13:05:36 +01:00
parent a0f97d2bf9
commit 24f68c0854
3 changed files with 4 additions and 3 deletions

View 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,

View 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.

View 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 {