From: Francis Dupont <fdupont@isc.org>
Date: Sun, 23 Sep 2018 10:50:01 +0000 (+0200)
Subject: [65-libyang-option-data] Addressed last comments (test doc and example)
X-Git-Tag: 65-libyang-option-data_before_rebase
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=238b49f3652c7ff1f925423adaf9139993a48645;p=thirdparty%2Fkea.git

[65-libyang-option-data] Addressed last comments (test doc and example)
---

diff --git a/src/lib/yang/tests/translator_option_data_unittests.cc b/src/lib/yang/tests/translator_option_data_unittests.cc
index dca33e2071..cef0f0d838 100644
--- a/src/lib/yang/tests/translator_option_data_unittests.cc
+++ b/src/lib/yang/tests/translator_option_data_unittests.cc
@@ -35,7 +35,8 @@ public:
     virtual ~TranslatorOptionDataListTest() { }
 };
 
-// Test get empty option data list.
+// This test verifies that an empty option data list can be properly
+// translated from YANG to JSON.
 TEST_F(TranslatorOptionDataListTest, getEmpty) {
     useModel("kea-dhcp4-server");
 
@@ -48,7 +49,8 @@ TEST_F(TranslatorOptionDataListTest, getEmpty) {
     EXPECT_EQ(0, options->size());
 }
 
-// Test get one option data.
+// This test verifies that one option data can be properly translated
+// from YANG to JSON.
 TEST_F(TranslatorOptionDataListTest, get) {
     useModel("kea-dhcp6-server");
 
@@ -80,7 +82,8 @@ TEST_F(TranslatorOptionDataListTest, get) {
     EXPECT_TRUE(option->equals(*options->get(0)));
 }
 
-// Test set empty option data list.
+// This test verifies that an empty option data list can be properly
+// translated from JSON to YANG.
 TEST_F(TranslatorOptionDataListTest, setEmpty) {
     useModel("kea-dhcp4-server");
 
@@ -96,7 +99,8 @@ TEST_F(TranslatorOptionDataListTest, setEmpty) {
     EXPECT_EQ(0, options->size());
 }
 
-// Test set an option data.
+// This test verifies that one option data can be properly translated
+// from JSON to YANG.
 TEST_F(TranslatorOptionDataListTest, set) {
     useModel("kea-dhcp6-server");
 
diff --git a/src/lib/yang/translator_option_data.h b/src/lib/yang/translator_option_data.h
index e6530b9aa6..9f88064fdb 100644
--- a/src/lib/yang/translator_option_data.h
+++ b/src/lib/yang/translator_option_data.h
@@ -42,6 +42,29 @@ namespace yang {
 //    +--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 (list instance)
+//  /kea-dhcp6-server:config/option-data-list/option-data/code = 100
+//  /kea-dhcp6-server:config/option-data-list/option-data/space = dns
+//  /kea-dhcp6-server:config/option-data-list/option-data/data = 12121212
+//  /kea-dhcp6-server:config/option-data-list/option-data/csv-format = false
+//  /kea-dhcp6-server:config/option-data-list/option-data/always-send = false
+// @endcode
 class TranslatorOptionData : virtual public TranslatorBasic {
 public: