From: Marcin Siodelski <marcin@isc.org>
Date: Fri, 26 Oct 2018 09:51:02 +0000 (+0200)
Subject: [64-client-class-cmds-hook] Better description of dependent_class parameter.
X-Git-Tag: 66-authoritative-flag-in-kea_base~24
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=b5696786abeca5343ceaf0c851d9b5c7d0f98bcf;p=thirdparty%2Fkea.git

[64-client-class-cmds-hook] Better description of dependent_class parameter.

This is in the ClientClassDef::dependOnClass. Review comment.
---

diff --git a/src/lib/dhcpsrv/client_class_def.cc b/src/lib/dhcpsrv/client_class_def.cc
index aeabd96d0f..2a9a52098a 100644
--- a/src/lib/dhcpsrv/client_class_def.cc
+++ b/src/lib/dhcpsrv/client_class_def.cc
@@ -287,14 +287,14 @@ ClientClassDictionary::getClasses() const {
 
 bool
 ClientClassDictionary::dependOnClass(const std::string& name,
-                                     std::string& depend) const {
+                                     std::string& dependent_class) const {
     // Skip previous classes as they should not depend on name.
     bool found = false;
     for (ClientClassDefList::iterator this_class = list_->begin();
          this_class != list_->end(); ++this_class) {
         if (found) {
             if ((*this_class)->dependOnClass(name)) {
-                depend = (*this_class)->getName();
+                dependent_class = (*this_class)->getName();
                 return (true);
             }
         } else {
diff --git a/src/lib/dhcpsrv/client_class_def.h b/src/lib/dhcpsrv/client_class_def.h
index 111458aedc..94e03c2c56 100644
--- a/src/lib/dhcpsrv/client_class_def.h
+++ b/src/lib/dhcpsrv/client_class_def.h
@@ -333,10 +333,11 @@ public:
     /// @brief Checks direct dependency.
     ///
     /// @param name The client class name.
-    /// @param depend Set to the name of the first depending class.
+    /// @param [out] dependent_class Reference to a variable where the
+    /// name of the first class depending on the checked class is set.
     ///
     /// @return true if a definition depends on the class name, false if none.
-    bool dependOnClass(const std::string& name, std::string& depend) const;
+    bool dependOnClass(const std::string& name, std::string& dependent_class) const;
 
     /// @brief Compares two @c ClientClassDictionary objects for equality.
     ///