summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrancis Dupont <fdupont@isc.org>2018-08-21 21:47:50 +0200
committerFrancis Dupont <fdupont@isc.org>2018-08-21 21:47:50 +0200
commit245df6e632194932726a2e6d32366c92218c96f7 (patch)
tree2c9859dcd2694ff733903df2063fb078cc0a6891
parent48d064438d6fb71c47bf26ccf7b08c5f2c974da6 (diff)
[master] Fixed doxygen warningsgitlab29-base
-rw-r--r--src/lib/dhcp/option6_auth.h3
-rw-r--r--src/lib/dhcpsrv/host.h24
2 files changed, 15 insertions, 12 deletions
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.
///