]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[65-libyang-adaptor] Added adaptor section in doxygen
authorFrancis Dupont <fdupont@isc.org>
Mon, 17 Sep 2018 20:39:25 +0000 (22:39 +0200)
committerFrancis Dupont <fdupont@isc.org>
Mon, 17 Sep 2018 20:39:25 +0000 (22:39 +0200)
src/lib/yang/yang.dox

index da9de2b373495abd04fecfb27a9b7aeb1f2096af..93c88397cbde8c926932cab6963cecabe985b12f 100644 (file)
@@ -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