[65-libyang-database] Fixed doxygen comments

diff --git a/src/lib/yang/translator_database.h b/src/lib/yang/translator_database.h
index 0c8e4505478814cf0c726af8c5a7b06a5ce17478..ce3e91d879b0a59dfc52010119d39b644158c1f6 100644 (file)
--- a/src/lib/yang/translator_database.h
+++ b/src/lib/yang/translator_database.h
@@ -13,93 +13,93 @@
 namespace isc {
 namespace yang {
 
-// Database access translation between YANG and JSON
-//
-// JSON syntax for all Kea servers with database access is:
-// @code
-// {
-//     "type": <type>, // required
-//     "user": <user>,
-//     "password": <password>,
-//     "host": <host>,
-//     "name": <name>,
-//     "persist": <persist flag>,
-//     "port": <port>,
-//     "lfc-interval": <lfc interval>,
-//     "readonly": <readonly flag>,
-//     "connect-timeout": <connect timeout>,
-//     "contact-points": <contact points>,
-//     "keyspace": <keyspace>,
-//     "max-reconnect-tries": <maximum reconnect tries>,
-//     "reconnect-wait-time": <reconnect wait time>,
-//     "request-timeout": <request timeout>,
-//     "tcp-keepalive": <TCP keepalive>,
-//     "tcp-nodelay": <TCP nodelay flag>,
-//     "user-context": { <json map> },
-//     "comment": <comment>
-// }
-// @endcode
-//
-// YANG syntax for kea-dhcp[46] is using database-type as the list key:
-// @code
-//  +--rw database                container
-//    |
-//    +--rw database-type?        string
-//    +--rw user?                 string
-//    +--rw password?             string
-//    +--rw host?                 string
-//    +--rw name?                 string
-//    +--rw persist?              boolean
-//    +--rw port?                 uint16
-//    +--rw lfc-interval?         uint32
-//    +--rw readonly?             boolean
-//    +--rw connect-timeout?      uint32
-//    +--rw contact-points?       string
-//    +--rw keyspace?             string
-//    +--rw max-reconnect-tries?  uint32
-//    +--rw reconnect-wait-time?  uint32
-//    +--rw request-timeout?      uint32
-//    +--rw tcp-keepalive?        uint32
-//    +--rw tcp-nodelay?          boolean
-//    +--rw user-context?         string
-// @endcode
-//
-// An example in JSON and YANG formats:
-// @code
-// [
-//     {
-//         "type": "mysql",
-//         "name": "kea",
-//         "user": "kea",
-//         "password": "kea",
-//         "host": "localhost",
-//         "port": 3306
-//     }
-// ]
-// @endcode
-// @code
-// /kea-dhcp6-server:config (container)
-// /kea-dhcp6-server:config/hosts-databases (container)
-// /kea-dhcp6-server:config/hosts-databases/
-//    hosts-database[database-type='mysql'] (list instance)
-// /kea-dhcp6-server:config/hosts-databases/
-//    hosts-database[database-type='mysql']/type = mysql
-// /kea-dhcp6-server:config/hosts-databases/
-//    hosts-database[database-type='mysql']/name = kea
-// /kea-dhcp6-server:config/hosts-databases/
-//    hosts-database[database-type='mysql']/user = kea
-// /kea-dhcp6-server:config/hosts-databases/
-//    hosts-database[database-type='mysql']/password = kea
-// /kea-dhcp6-server:config/hosts-databases/
-//    hosts-database[database-type='mysql']/host = localhost
-// /kea-dhcp6-server:config/hosts-databases/
-//    hosts-database[database-type='mysql']/port = 3306
-// @endcode
-
-// @brief A translator class for converting a database access between
-// YANG and JSON.
-//
-// Supports kea-dhcp[46]-server, not yet ietf-dhcpv6-server.
+/// Database access translation between YANG and JSON
+///
+/// JSON syntax for all Kea servers with database access is:
+/// @code
+/// {
+///     "type": <type>, /// required
+///     "user": <user>,
+///     "password": <password>,
+///     "host": <host>,
+///     "name": <name>,
+///     "persist": <persist flag>,
+///     "port": <port>,
+///     "lfc-interval": <lfc interval>,
+///     "readonly": <readonly flag>,
+///     "connect-timeout": <connect timeout>,
+///     "contact-points": <contact points>,
+///     "keyspace": <keyspace>,
+///     "max-reconnect-tries": <maximum reconnect tries>,
+///     "reconnect-wait-time": <reconnect wait time>,
+///     "request-timeout": <request timeout>,
+///     "tcp-keepalive": <TCP keepalive>,
+///     "tcp-nodelay": <TCP nodelay flag>,
+///     "user-context": { <json map> },
+///     "comment": <comment>
+/// }
+/// @endcode
+///
+/// YANG syntax for kea-dhcp[46] is using database-type as the list key:
+/// @code
+///  +--rw database                container
+///    |
+///    +--rw database-type?        string
+///    +--rw user?                 string
+///    +--rw password?             string
+///    +--rw host?                 string
+///    +--rw name?                 string
+///    +--rw persist?              boolean
+///    +--rw port?                 uint16
+///    +--rw lfc-interval?         uint32
+///    +--rw readonly?             boolean
+///    +--rw connect-timeout?      uint32
+///    +--rw contact-points?       string
+///    +--rw keyspace?             string
+///    +--rw max-reconnect-tries?  uint32
+///    +--rw reconnect-wait-time?  uint32
+///    +--rw request-timeout?      uint32
+///    +--rw tcp-keepalive?        uint32
+///    +--rw tcp-nodelay?          boolean
+///    +--rw user-context?         string
+/// @endcode
+///
+/// An example in JSON and YANG formats:
+/// @code
+/// [
+///     {
+///         "type": "mysql",
+///         "name": "kea",
+///         "user": "kea",
+///         "password": "kea",
+///         "host": "localhost",
+///         "port": 3306
+///     }
+/// ]
+/// @endcode
+/// @code
+/// /kea-dhcp6-server:config (container)
+/// /kea-dhcp6-server:config/hosts-databases (container)
+/// /kea-dhcp6-server:config/hosts-databases/
+///    hosts-database[database-type='mysql'] (list instance)
+/// /kea-dhcp6-server:config/hosts-databases/
+///    hosts-database[database-type='mysql']/type = mysql
+/// /kea-dhcp6-server:config/hosts-databases/
+///    hosts-database[database-type='mysql']/name = kea
+/// /kea-dhcp6-server:config/hosts-databases/
+///    hosts-database[database-type='mysql']/user = kea
+/// /kea-dhcp6-server:config/hosts-databases/
+///    hosts-database[database-type='mysql']/password = kea
+/// /kea-dhcp6-server:config/hosts-databases/
+///    hosts-database[database-type='mysql']/host = localhost
+/// /kea-dhcp6-server:config/hosts-databases/
+///    hosts-database[database-type='mysql']/port = 3306
+/// @endcode
+
+/// @brief A translator class for converting a database access between
+/// YANG and JSON.
+///
+/// Supports kea-dhcp[46]-server, not yet ietf-dhcpv6-server.
 class TranslatorDatabase : virtual public TranslatorBasic {
 public:
 
@@ -152,10 +152,10 @@ protected:
     std::string model_;
 };
 
-// @brief A translator class for converting a database access list between
-// YANG and JSON.
-//
-// Supports kea-dhcp[46]-server, does not exist in ietf-dhcpv6-server.
+/// @brief A translator class for converting a database access list between
+/// YANG and JSON.
+///
+/// Supports kea-dhcp[46]-server, does not exist in ietf-dhcpv6-server.
 class TranslatorDatabases : virtual public TranslatorDatabase {
 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: