From: Marcin Siodelski <marcin@isc.org>
Date: Tue, 28 Nov 2023 11:44:59 +0000 (+0100)
Subject: [#3106] Extended getConfig description
X-Git-Tag: Kea-2.5.5~125
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a0f97d2bf9f903e5dc3a8283e79ba697bfa45203;p=thirdparty%2Fkea.git

[#3106] Extended getConfig description
---

diff --git a/src/hooks/dhcp/high_availability/ha_impl.h b/src/hooks/dhcp/high_availability/ha_impl.h
index 1cdc93ff8b..bebf3f420b 100644
--- a/src/hooks/dhcp/high_availability/ha_impl.h
+++ b/src/hooks/dhcp/high_availability/ha_impl.h
@@ -59,7 +59,16 @@ public:
 
 public:
 
-    /// @brief Returns sole parsed configuration.
+    /// @brief Returns a configuration for the first relationship.
+    ///
+    /// This function is held here for historical reasons and it is currently
+    /// only used in the unit tests for a single-relationship test cases. The
+    /// production code should use the other variant of this function that
+    /// includes a partner name as a parameter. It coveres both the cases when
+    /// there is only one relationship and the hub-and-spoke case.
+    ///
+    /// @return Configuration for the relationship to which the partner belongs.
+    /// @throw InvalidOperation when there are no relationships.
     HAConfigPtr getConfig() const {
         return (config_->get());
     }