]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#65, !27] Minor comments connection.
authorTomek Mrugalski <tomasz@isc.org>
Fri, 12 Oct 2018 13:24:59 +0000 (15:24 +0200)
committerTomek Mrugalski <tomasz@isc.org>
Fri, 12 Oct 2018 13:24:59 +0000 (15:24 +0200)
src/lib/yang/translator_control_socket.h

index a31740b5237bf660be853ffaefda860889d99d61..0f5e31b68dbea76da3c5f8de0fc7ae911172c210 100644 (file)
@@ -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.