From: Tomek Mrugalski Date: Tue, 16 Oct 2018 13:29:52 +0000 (+0200) Subject: [#65,!28] Minor comment changes after review. X-Git-Tag: 171-keactrl-tests-not-posix_base~6 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fheads%2F65-libyang-database;p=thirdparty%2Fkea.git [#65,!28] Minor comment changes after review. --- diff --git a/src/lib/yang/translator_database.h b/src/lib/yang/translator_database.h index ce3e91d879..74459c90c4 100644 --- a/src/lib/yang/translator_database.h +++ b/src/lib/yang/translator_database.h @@ -96,10 +96,12 @@ namespace yang { /// hosts-database[database-type='mysql']/port = 3306 /// @endcode -/// @brief A translator class for converting a database access between -/// YANG and JSON. +/// @brief A translator class for converting a database access parameters +/// between YANG and JSON. /// -/// Supports kea-dhcp[46]-server, not yet ietf-dhcpv6-server. +/// Supports the following models: +/// - kea-dhcp4-server +/// - kea-dhcp6-server class TranslatorDatabase : virtual public TranslatorBasic { public: @@ -131,14 +133,14 @@ public: bool skip = false); protected: - /// @brief getDatabase JSON for kea-dhcp[46]. + /// @brief getDatabase JSON for kea-dhcp[46]-server models. /// /// @param xpath The xpath of the database. /// @return JSON representation of the database or null if none. /// @throw SysrepoError when sysrepo raises an error. isc::data::ElementPtr getDatabaseKea(const std::string& xpath); - /// @brief setDatabase for kea-dhcp[46]. + /// @brief setDatabase for kea-dhcp[46]-server models. /// /// @param xpath The xpath of the database access. /// @param elem The JSON element. @@ -185,14 +187,14 @@ public: isc::data::ConstElementPtr elem); protected: - /// @brief getDatabases JSON for kea-dhcp[46]. + /// @brief getDatabases JSON for kea-dhcp[46]-server models. /// /// @param xpath The xpath of databases. /// @return JSON representation of databases. /// @throw SysrepoError when sysrepo raises an error. isc::data::ElementPtr getDatabasesKea(const std::string& xpath); - /// @brief setDatabases for kea-dhcp[46]. + /// @brief setDatabases for kea-dhcp[46]-server models. /// /// @param xpath The xpath of databases. /// @param elem The JSON element.