From: Tomek Mrugalski <tomasz@isc.org>
Date: Fri, 12 Oct 2018 13:24:59 +0000 (+0200)
Subject: [#65, !27] Minor comments connection.
X-Git-Tag: 165-netbsd-8-fixes_base^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8597a41777656757ccfa289c59adbd942a6fdaa3;p=thirdparty%2Fkea.git

[#65, !27] Minor comments connection.
---

diff --git a/src/lib/yang/translator_control_socket.h b/src/lib/yang/translator_control_socket.h
index a31740b523..0f5e31b68d 100644
--- a/src/lib/yang/translator_control_socket.h
+++ b/src/lib/yang/translator_control_socket.h
@@ -62,8 +62,11 @@ namespace yang {
 /// @brief A translator class for converting a control socket between
 /// YANG and JSON.
 ///
-/// Supports all kea-* models at the exception of kea-dhcp-ddns.
-/// Specific to Kea so does not exists in ietf-dhcpv6-server.
+/// Supports the following models:
+/// - kea-dhcp4-server
+/// - kea-dhcp6-server
+/// - kea-dhcp-ddns
+/// - kea-ctrl-agent
 class TranslatorControlSocket : virtual public TranslatorBasic {
 public:
 
@@ -101,6 +104,8 @@ protected:
     /// @brief setControlSocket for kea models.
     ///
     /// Null elem argument removes the container.
+    /// Required parameters passed in elem are: socket-name, socket-type.
+    /// Optional parameters are: user-context.
     ///
     /// @param xpath The xpath of the control socket.
     /// @param elem The JSON element.