Parcourir la source

[3210] Fixed trivial issues in the CfgMgr.

This commit includes trivial changes to the doxygen documentation and
make one variable const.
Marcin Siodelski il y a 11 ans
Parent
commit
9d3cf130a0
1 fichiers modifiés avec 5 ajouts et 5 suppressions
  1. 5 5
      src/lib/dhcpsrv/cfgmgr.h

+ 5 - 5
src/lib/dhcpsrv/cfgmgr.h

@@ -316,22 +316,22 @@ public:
     const isc::asiolink::IOAddress*
     getUnicast(const std::string& iface) const;
 
-
-    /// @brief sets whether server should send back client-id in DHCPv4
+    /// @brief Sets whether server should send back client-id in DHCPv4
     ///
     /// This is a compatibility flag. The default (true) is compliant with
     /// RFC6842. False is for backward compatibility.
     ///
     /// @param echo should the client-id be sent or not
-    void echoClientId(bool echo) {
+    void echoClientId(const bool echo) {
         echo_v4_client_id_ = echo;
     }
 
-    /// @brief returns whether server should send back client-id in DHCPv4
-    /// @param returns whether v4 client-id should be returned or not
+    /// @brief Returns whether server should send back client-id in DHCPv4.
+    /// @return true if client-id should be returned, false otherwise.
     bool echoClientId() const {
         return (echo_v4_client_id_);
     }
+
 protected:
 
     /// @brief Protected constructor.