From: Marcin Siodelski <marcin@isc.org>
Date: Wed, 8 Jun 2016 14:00:38 +0000 (+0200)
Subject: [4317] Addressed review comments.
X-Git-Tag: trac4106_update_base~1^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=279a86be117a0b13d70d52000c66e05c6b07e46a;p=thirdparty%2Fkea.git

[4317] Addressed review comments.
---

diff --git a/src/lib/dhcpsrv/host.h b/src/lib/dhcpsrv/host.h
index 433ac3dad6..8b38185a5e 100644
--- a/src/lib/dhcpsrv/host.h
+++ b/src/lib/dhcpsrv/host.h
@@ -176,10 +176,10 @@ public:
     /// @brief Type of the host identifier.
     ///
     /// Currently supported identifiers are:
-    /// - hardware address (DHCPv4 and DHCPv6),
-    /// - DUID (DHCPv4 and DHCPv6),
-    /// - circuit identifier (DHCPv4),
-    /// - client identifier (DHCPv4).
+    /// - hardware address (DHCPv4 and DHCPv6) (identifier name: "hw-address"),
+    /// - DUID (DHCPv4 and DHCPv6) (identifier name: "duid"),
+    /// - circuit identifier (DHCPv4) (identifier name: "circuit-id"),
+    /// - client identifier (DHCPv4) (identifier name: "client-id")
     enum IdentifierType {
         IDENT_HWADDR,
         IDENT_DUID,
@@ -244,7 +244,8 @@ public:
     ///
     /// @param identifier Identifier in the textual format. The expected formats
     /// for the hardware address and other identifiers are provided above.
-    /// @param identifier_name One of "hw-address", "duid", "circuit-id", "client-id".
+    /// @param identifier_name One of the supported identifiers in the text form as
+    /// described for @ref IdentifierType.
     /// @param ipv4_subnet_id Identifier of the IPv4 subnet to which the host
     /// is connected.
     /// @param ipv6_subnet_id Identifier of the IPv6 subnet to which the host
@@ -286,7 +287,8 @@ public:
     /// This method is called by the @c Host constructor.
     ///
     /// @param identifier Reference to a new identifier in the textual format.
-    /// @param name One of "hw-address", "duid", "circuit-id", "client-id".
+    /// @param name One of the supported identifiers in the text form as
+    /// described for @ref IdentifierType.
     ///
     /// @throw BadValue if the identifier is invalid.
     void setIdentifier(const std::string& identifier, const std::string& name);
diff --git a/src/lib/dhcpsrv/tests/host_reservation_parser_unittest.cc b/src/lib/dhcpsrv/tests/host_reservation_parser_unittest.cc
index dc48e08eee..05a6a43810 100644
--- a/src/lib/dhcpsrv/tests/host_reservation_parser_unittest.cc
+++ b/src/lib/dhcpsrv/tests/host_reservation_parser_unittest.cc
@@ -492,7 +492,7 @@ TEST_F(HostReservationParserTest, dhcp6CircuitId) {
 // This test verifies that host reservation parser for DHCPv6 rejects
 // "client-id" as a host identifier.
 TEST_F(HostReservationParserTest, dhcp6ClientId) {
-    // Use DHCPv4 specific identifier 'circuit-id' with DHCPv6 parser.
+    // Use DHCPv4 specific identifier 'client-id' with DHCPv6 parser.
     std::string config = "{ \"client-id\": \"01010203040506\","
         "\"ip-addresses\": [ \"2001:db8:1::100\", \"2001:db8:1::200\" ],"
         "\"prefixes\": [ ],"