[65-libyang-logger] Fixed doxygen comments

diff --git a/src/lib/yang/translator_logger.h b/src/lib/yang/translator_logger.h
index ec5470d236ef6009553345eff1723b2f4425142a..e57042ba0fe67fa3476d94fa426a886388d977b2 100644 (file)
--- a/src/lib/yang/translator_logger.h
+++ b/src/lib/yang/translator_logger.h
@@ -13,83 +13,83 @@
 namespace isc {
 namespace yang {
 
-// Logger translation between YANG and JSON
-//
-// JSON syntax for all Kea servers with loggers is:
-// @code
-// {
-//     "name": <name>,
-//     "output_options": [ <output options> ],
-//     "severity": <severity>,
-//     "debuglevel": <debug level>,
-//     "user-context": { <json map> },
-//     "comment": <comment>
-// }
-// @endcode
-//
-// JSON syntax for all Kea server for output options is:
-// @code
-// {
-//    "output": <output, e.g. log file name>,
-//    "maxver": <maximum file version>,
-//    "maxsize": <maxium file size>,
-//    "flush": <flush flag>
-// }
-// @endcode
-//
-// YANG syntax for kea-logging is with name as the logger list key and
-// output as the output option list key.
-// @code
-//  +--rw logger               container
-//     |
-//     +--rw name?             string
-//     +--rw output-options    container
-//     |  +--rw option*        [output]
-//     |     +--rw output      string
-//     |     +--rw maxver?     uint32
-//     |     +--rw maxsize?    uint32
-//     |     +--rw flush?      boolean
-//     +--rw debuglevel?       uint8
-//     +--rw severity?         enumeration
-//     +--rw user-context?     string
-// @endcode
-//
-// An example in JSON and YANG formats:
-// @code
-// [
-//     {
-//         "name": "foo",
-//         "severity": "WARN",
-//         "output_options":
-//             [
-//                 {
-//                     "output": "/bar",
-//                     "maxver": 10
-//                 }
-//             ]
-//     }
-// ]
-// @endcode
-// @code
-//  /kea-dhcp4-server:logging (container)
-//  /kea-dhcp4-server:logging/loggers (container)
-//  /kea-dhcp4-server:logging/loggers/logger[name='foo'] (list instance)
-//  /kea-dhcp4-server:logging/loggers/logger[name='foo']/name = foo
-//  /kea-dhcp4-server:logging/loggers/logger[name='foo']/
-//     output-options (container)
-//  /kea-dhcp4-server:logging/loggers/logger[name='foo']/output-options/
-//     option[output='/bar'] (list instance)
-//  /kea-dhcp4-server:logging/loggers/logger[name='foo']/output-options/
-//     option[output='/bar']/option = /bar
-//  /kea-dhcp4-server:logging/loggers/logger[name='foo']/output-options/
-//     option[output='/bar']/maxver = 10
-//  /kea-dhcp4-server:logging/loggers/logger[name='foo']/severity = WARN
-// @endcode
-
-// @brief A translator class for converting a logger between
-// YANG and JSON.
-//
-// Currently supports all kea servers and agents. Speficic to Kea.
+/// Logger translation between YANG and JSON
+///
+/// JSON syntax for all Kea servers with loggers is:
+/// @code
+/// {
+///     "name": <name>,
+///     "output_options": [ <output options> ],
+///     "severity": <severity>,
+///     "debuglevel": <debug level>,
+///     "user-context": { <json map> },
+///     "comment": <comment>
+/// }
+/// @endcode
+///
+/// JSON syntax for all Kea server for output options is:
+/// @code
+/// {
+///    "output": <output, e.g. log file name>,
+///    "maxver": <maximum file version>,
+///    "maxsize": <maxium file size>,
+///    "flush": <flush flag>
+/// }
+/// @endcode
+///
+/// YANG syntax for kea-logging is with name as the logger list key and
+/// output as the output option list key.
+/// @code
+///  +--rw logger               container
+///     |
+///     +--rw name?             string
+///     +--rw output-options    container
+///     |  +--rw option*        [output]
+///     |     +--rw output      string
+///     |     +--rw maxver?     uint32
+///     |     +--rw maxsize?    uint32
+///     |     +--rw flush?      boolean
+///     +--rw debuglevel?       uint8
+///     +--rw severity?         enumeration
+///     +--rw user-context?     string
+/// @endcode
+///
+/// An example in JSON and YANG formats:
+/// @code
+/// [
+///     {
+///         "name": "foo",
+///         "severity": "WARN",
+///         "output_options":
+///             [
+///                 {
+///                     "output": "/bar",
+///                     "maxver": 10
+///                 }
+///             ]
+///     }
+/// ]
+/// @endcode
+/// @code
+///  /kea-dhcp4-server:logging (container)
+///  /kea-dhcp4-server:logging/loggers (container)
+///  /kea-dhcp4-server:logging/loggers/logger[name='foo'] (list instance)
+///  /kea-dhcp4-server:logging/loggers/logger[name='foo']/name = foo
+///  /kea-dhcp4-server:logging/loggers/logger[name='foo']/
+///     output-options (container)
+///  /kea-dhcp4-server:logging/loggers/logger[name='foo']/output-options/
+///     option[output='/bar'] (list instance)
+///  /kea-dhcp4-server:logging/loggers/logger[name='foo']/output-options/
+///     option[output='/bar']/option = /bar
+///  /kea-dhcp4-server:logging/loggers/logger[name='foo']/output-options/
+///     option[output='/bar']/maxver = 10
+///  /kea-dhcp4-server:logging/loggers/logger[name='foo']/severity = WARN
+/// @endcode
+
+/// @brief A translator class for converting a logger between
+/// YANG and JSON.
+///
+/// Currently supports all kea servers and agents. Speficic to Kea.
 class TranslatorLogger : virtual public TranslatorBasic {
 public:
 
@@ -163,10 +163,10 @@ protected:
     std::string model_;
 };
 
-// @brief A translator class for converting a logger list between
-// YANG and JSON.
-//
-// Currently supports all kea servers and agents. Speficic to Kea.
+/// @brief A translator class for converting a logger list between
+/// YANG and JSON.
+///
+/// Currently supports all kea servers and agents. Speficic to Kea.
 class TranslatorLoggers : virtual public TranslatorLogger {
 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: