From: Francis Dupont <fdupont@isc.org>
Date: Tue, 21 Aug 2018 19:47:50 +0000 (+0200)
Subject: [master] Fixed doxygen warnings
X-Git-Tag: gitlab29-base
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=245df6e632194932726a2e6d32366c92218c96f7;p=thirdparty%2Fkea.git

[master] Fixed doxygen warnings
---

diff --git a/src/lib/dhcp/option6_auth.h b/src/lib/dhcp/option6_auth.h
index 91e5f5025e..f2d98d55cd 100644
--- a/src/lib/dhcp/option6_auth.h
+++ b/src/lib/dhcp/option6_auth.h
@@ -90,8 +90,9 @@ public:
 
     /// Set replay detection method value
     ///
-    /// @param rdm replay detection method value to be set
+    /// @param value replay detection method value to be set
     void setReplyDetectionValue(uint64_t value) { rdm_value_ = value; }
+
     /// Set authentication information 
     ///
     /// @param auth_info authentication information to be set
diff --git a/src/lib/dhcpsrv/host.h b/src/lib/dhcpsrv/host.h
index ef2ba18042..b1e6a5b4b6 100644
--- a/src/lib/dhcpsrv/host.h
+++ b/src/lib/dhcpsrv/host.h
@@ -38,16 +38,16 @@ public:
 
     /// @brief Constructor
     ///
-    /// Constructor for assigning auth keys in host reservation
-    ///  Ensures the key length is not greater than 16 bytes
-    /// @param string auth key to be stored
+    /// Constructor for assigning auth keys in host reservation.
+    /// Ensures the key length is not greater than 16 bytes.
+    /// @param key auth key to be stored
     AuthKey(const std::string key);
     
     /// @brief Constructor
     ///
-    /// Constructor for generating auth keys, with no argument
-    /// shall use the internal function for generationg random keys
-    AuthKey(void);
+    /// Constructor for generating auth keys, with no argument.
+    /// shall use the internal function for generationg random keys.
+    AuthKey();
 
     // @brief get random string
     ///
@@ -62,7 +62,7 @@ public:
     /// Set the key value.
     //  If the size is greater than 16 bytes, we resize to 16 Bytes
     /// Doesnt throw an exception
-    /// @param string key to be stored
+    /// @param key auth key to be stored
     void setAuthKey(const std::string& key);
 
     /// @brief return auth key
@@ -82,13 +82,13 @@ public:
     /// @brief equality operator
     ///
     /// equality operator to compare two AuthKey classes
-    /// @param Authkey to be compared against
+    /// @param other Authkey to be compared against
     bool operator==(const AuthKey& other) const;
 
     /// @brief inequality operator
     ///
     /// inequality operator to compare two AuthKey classes
-    /// @param Authkey to be compared against
+    /// @param other Authkey to be compared against
     bool operator!=(const AuthKey& other) const;
 
 private:
@@ -287,6 +287,7 @@ public:
     /// @param next_server IPv4 address of next server (siaddr).
     /// @param server_host_name Server host name (a.k.a. sname).
     /// @param boot_file_name Boot file name (a.k.a. file).
+    /// @param auth_key Authentication key.
     ///
     /// @throw BadValue if the provided values are invalid. In particular,
     /// if the identifier is invalid.
@@ -300,7 +301,7 @@ public:
          const asiolink::IOAddress& next_server = asiolink::IOAddress::IPV4_ZERO_ADDRESS(),
          const std::string& server_host_name = "",
          const std::string& boot_file_name = "",
-         const AuthKey& auth_key = std::string(""));
+         const AuthKey& auth_key = AuthKey(""));
 
     /// @brief Constructor.
     ///
@@ -338,6 +339,7 @@ public:
     /// @param next_server IPv4 address of next server (siaddr).
     /// @param server_host_name Server host name (a.k.a. sname).
     /// @param boot_file_name Boot file name (a.k.a. file).
+    /// @param auth_key Authentication key.
     ///
     /// @throw BadValue if the provided values are invalid. In particular,
     /// if the identifier is invalid.
@@ -350,7 +352,7 @@ public:
          const asiolink::IOAddress& next_server = asiolink::IOAddress::IPV4_ZERO_ADDRESS(),
          const std::string& server_host_name = "",
          const std::string& boot_file_name = "",
-         const AuthKey& auth_key = std::string(""));
+         const AuthKey& auth_key = AuthKey(""));
 
     /// @brief Replaces currently used identifier with a new identifier.
     ///