From: Francis Dupont <fdupont@isc.org>
Date: Mon, 17 Sep 2018 20:39:25 +0000 (+0200)
Subject: [65-libyang-adaptor] Added adaptor section in doxygen
X-Git-Tag: 30-implement-control-socket-for-ddns_base~1^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=94c36f9d553dfb559f5529491a8b79b9bd15438f;p=thirdparty%2Fkea.git

[65-libyang-adaptor] Added adaptor section in doxygen
---

diff --git a/src/lib/yang/yang.dox b/src/lib/yang/yang.dox
index da9de2b373..93c88397cb 100644
--- a/src/lib/yang/yang.dox
+++ b/src/lib/yang/yang.dox
@@ -49,7 +49,7 @@ implements some variants to accommodate the model with shared code
 moved into a common private routine.
 
 @c isc::yang::TranslatorPools deals with a list of pools. The getPools
-method iterates over thr lidt in both ways. Loot at examples in unit
+method iterates over the list in both ways. Look at examples in unit
 tests to understand how can be filled.
 
 Note pools show two shortcomings in IETF models:
@@ -62,6 +62,16 @@ Note pools show two shortcomings in IETF models:
 The new thing here is the use of adaptors to move timers from subnets
 to pools and back.
 
+@section yangAdaptor Adapting JSON configuration
+
+Adaptors are tools which adapts JSON complete or partial configuration
+before translation to Yang to ease this translation or after translation
+from Yang to follow the Kea syntax, for instance by adding static
+components which are not in the model.
+
+Methods provided by adaptors are class methods (i.e. declared static).
+Specific adaptors are derived from the isc::yang::Adaptor base class.
+
  @page unitTestsSysrepo Running unit-tests with Sysrepo
 
 To run YANG/NETCONF/Sysrepo tests you obviously need to compile Kea with