[#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 1cdc93ff8b285a154d0efc395e608fcaaf936304..bebf3f420bb156ee0d222c42bc254878b5340384 100644 (file)
--- 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());
     }