]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#1087] Added missing function descriptions
authorMarcin Siodelski <marcin@isc.org>
Thu, 14 May 2020 15:52:30 +0000 (17:52 +0200)
committerMarcin Siodelski <marcin@isc.org>
Wed, 20 May 2020 15:48:15 +0000 (17:48 +0200)
Added descriptions to two functions in the communication state in HA.

src/hooks/dhcp/high_availability/communication_state.h

index 1ced58daec15cb94ceeace696247928c16a5bd9c..0edf7f84be7c1816571561d6297f7cc75b420e68 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2018-2019 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2018-2020 Internet Systems Consortium, Inc. ("ISC")
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -101,10 +101,16 @@ public:
     /// @throw BadValue if unsupported state value was provided.
     void setPartnerState(const std::string& state);
 
+    /// @brief Returns scopes served by the partner server.
+    ///
+    /// @return A set of scopes served by the partner.
     std::set<std::string> getPartnerScopes() const {
         return (partner_scopes_);
     }
 
+    /// @brief Sets partner scopes.
+    ///
+    /// @param new_scopes Partner scopes enclosed in a JSON list.
     void setPartnerScopes(data::ConstElementPtr new_scopes);
 
     /// @brief Starts recurring heartbeat (public interface).