[65-libyang-control-socket] Fixed doxygen comments

diff --git a/src/lib/yang/translator_control_socket.h b/src/lib/yang/translator_control_socket.h
index b8e923efa97859b1b158592bb8989f0321e73d54..a31740b5237bf660be853ffaefda860889d99d61 100644 (file)
--- a/src/lib/yang/translator_control_socket.h
+++ b/src/lib/yang/translator_control_socket.h
@@ -13,57 +13,57 @@
 namespace isc {
 namespace yang {
 
-// Control socket translation between YANG and JSON
-//
-// JSON syntax for all Kea servers with command channel is:
-// @code
-// "control-socket": {
-//     "socket-type": "<socket type>",
-//     "socket-name": "<socket name>",
-//     "user-context": { <json map> },
-//     "comment": "<comment>"
-// }
-// @endcode
-//
-// YANG syntax is:
-// @code
-//  +--rw control-socket   container
-//    |
-//    +--rw socket-name    string
-//    +--rw socket-type    enumeration
-//    +--rw user-context?  string
-// @endcode
-//
-// An example in JSON and YANG formats:
-// @code
-// {
-//     "socket-name": "/tmp/kea.sock",
-//     "socket-type": "unix",
-//     "user-context": { "foo": 1 }
-// }
-// @endcode
-// @code
-//  /kea-ctrl-agent:config (container)
-//  /kea-ctrl-agent:config/control-sockets (container)
-//  /kea-ctrl-agent:config/control-sockets/
-//     socket[server-type='dhcp4'] (list instance)
-//  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
-//     server-type = dhcp4
-//  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
-//     control-socket (container)
-//  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
-//     control-socket/socket-name = /tmp/kea.sock
-//  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
-//     control-socket/socket-type = unix
-//  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
-//     control-socket/user-context = { \"foo\": 1 }
-// @endcode
+/// Control socket translation between YANG and JSON
+///
+/// JSON syntax for all Kea servers with command channel is:
+/// @code
+/// "control-socket": {
+///     "socket-type": "<socket type>",
+///     "socket-name": "<socket name>",
+///     "user-context": { <json map> },
+///     "comment": "<comment>"
+/// }
+/// @endcode
+///
+/// YANG syntax is:
+/// @code
+///  +--rw control-socket   container
+///    |
+///    +--rw socket-name    string
+///    +--rw socket-type    enumeration
+///    +--rw user-context?  string
+/// @endcode
+///
+/// An example in JSON and YANG formats:
+/// @code
+/// {
+///     "socket-name": "/tmp/kea.sock",
+///     "socket-type": "unix",
+///     "user-context": { "foo": 1 }
+/// }
+/// @endcode
+/// @code
+///  /kea-ctrl-agent:config (container)
+///  /kea-ctrl-agent:config/control-sockets (container)
+///  /kea-ctrl-agent:config/control-sockets/
+///     socket[server-type='dhcp4'] (list instance)
+///  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
+///     server-type = dhcp4
+///  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
+///     control-socket (container)
+///  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
+///     control-socket/socket-name = /tmp/kea.sock
+///  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
+///     control-socket/socket-type = unix
+///  /kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
+///     control-socket/user-context = { \"foo\": 1 }
+/// @endcode
 
-// @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.
+/// @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.
 class TranslatorControlSocket : virtual public TranslatorBasic {
 public:
 

diff --git a/src/lib/yang/translator_option_data.h b/src/lib/yang/translator_option_data.h
index 17a2ed3dbd900ab47a19312b064dd7c170ab1092..d286d68d8075adab5226034c69c178593618bcea 100644 (file)
--- a/src/lib/yang/translator_option_data.h
+++ b/src/lib/yang/translator_option_data.h
@@ -13,66 +13,66 @@
 namespace isc {
 namespace yang {
 
-// Option data translation between YANG and JSON
-//
-// JSON syntax for Kea DHCP with command channel is:
-// @code
-// {
-//     "code": <code>,
-//     "name": <name>,
-//     "space": <space>,
-//     "csv-format": <csv format flag>,
-//     "data": <value>,
-//     "always-send": <always send flag>,
-//     "user-context": { <json map> },
-//     "comment": "<comment>"
-// }
-// @endcode
-//
-// YANG syntax for kea-dhcp[46] with code and space as keys is:
-// @code
-//    +--rw name?          string
-//    +--rw data?          string
-//    +--rw code           uint8 / uint16
-//    +--rw space          string
-//    +--rw csv-format?    string
-//    +--rw always-send?   boolean
-//    +--rw user-context?  string
-// @endcode
-//
-// An example in JSON and YANG formats:
-// @code
-// [
-//     {
-//         "code": 100,
-//         "space": "dns",
-//         "csv-format": false,
-//         "data": "12121212",
-//         "always-send": false
-//     }
-// ]
-// @endcode
-// @code
-//  /kea-dhcp6-server:config (container)
-//  /kea-dhcp6-server:config/option-data-list (container)
-//  /kea-dhcp6-server:config/option-data-list/
-//     option-data[code='100'][space='dns'] (list instance)
-//  /kea-dhcp6-server:config/option-data-list/
-//     option-data[code='100'][space='dns']/code = 100
-//  /kea-dhcp6-server:config/option-data-list/
-//     option-data[code='100'][space='dns']/space = dns
-//  /kea-dhcp6-server:config/option-data-list/
-//     option-data[code='100'][space='dns']/data = 12121212
-//  /kea-dhcp6-server:config/option-data-list/
-//     option-data[code='100'][space='dns']/csv-format = false
-//  /kea-dhcp6-server:config/option-data-list/
-//     option-data[code='100'][space='dns']/always-send = false
-// @endcode
-
-// @brief A translator class for converting an option data between
-// YANG and JSON.
-//
-// Currently supports on kea-dhcp[46]-server, not yet ietf-dhcpv6-server.
+/// Option data translation between YANG and JSON
+///
+/// JSON syntax for Kea DHCP with command channel is:
+/// @code
+/// {
+///     "code": <code>,
+///     "name": <name>,
+///     "space": <space>,
+///     "csv-format": <csv format flag>,
+///     "data": <value>,
+///     "always-send": <always send flag>,
+///     "user-context": { <json map> },
+///     "comment": "<comment>"
+/// }
+/// @endcode
+///
+/// YANG syntax for kea-dhcp[46] with code and space as keys is:
+/// @code
+///    +--rw name?          string
+///    +--rw data?          string
+///    +--rw code           uint8 / uint16
+///    +--rw space          string
+///    +--rw csv-format?    string
+///    +--rw always-send?   boolean
+///    +--rw user-context?  string
+/// @endcode
+///
+/// An example in JSON and YANG formats:
+/// @code
+/// [
+///     {
+///         "code": 100,
+///         "space": "dns",
+///         "csv-format": false,
+///         "data": "12121212",
+///         "always-send": false
+///     }
+/// ]
+/// @endcode
+/// @code
+///  /kea-dhcp6-server:config (container)
+///  /kea-dhcp6-server:config/option-data-list (container)
+///  /kea-dhcp6-server:config/option-data-list/
+///     option-data[code='100'][space='dns'] (list instance)
+///  /kea-dhcp6-server:config/option-data-list/
+///     option-data[code='100'][space='dns']/code = 100
+///  /kea-dhcp6-server:config/option-data-list/
+///     option-data[code='100'][space='dns']/space = dns
+///  /kea-dhcp6-server:config/option-data-list/
+///     option-data[code='100'][space='dns']/data = 12121212
+///  /kea-dhcp6-server:config/option-data-list/
+///     option-data[code='100'][space='dns']/csv-format = false
+///  /kea-dhcp6-server:config/option-data-list/
+///     option-data[code='100'][space='dns']/always-send = false
+/// @endcode
+
+/// @brief A translator class for converting an option data between
+/// YANG and JSON.
+///
+/// Currently supports on kea-dhcp[46]-server, not yet ietf-dhcpv6-server.
 class TranslatorOptionData : virtual public TranslatorBasic {
 public:
 
@@ -119,10 +119,10 @@ protected:
     std::string model_;
 };
 
-// @brief A translator class for converting an option data list between
-// YANG and JSON.
-//
-// Currently supports on kea-dhcp[46]-server, not yet ietf-dhcpv6-server.
+/// @brief A translator class for converting an option data list between
+/// YANG and JSON.
+///
+/// Currently supports on kea-dhcp[46]-server, not yet ietf-dhcpv6-server.
 class TranslatorOptionDataList : virtual public TranslatorOptionData {
 public: