BIND 10 trac1206, updated. 5e14c4caafaa44b92134c5df01b726f435f46845 [1206] forgot to commit these doc additions

[BIND 10 source code commits]

The branch, trac1206 has been updated
       via  5e14c4caafaa44b92134c5df01b726f435f46845 (commit)
      from  58b843554162e6599ba895c8325985f74adef734 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 5e14c4caafaa44b92134c5df01b726f435f46845
Author: Jelte Jansen <jelte at isc.org>
Date:   Wed Sep 28 09:04:20 2011 +0200

    [1206] forgot to commit these doc additions

-----------------------------------------------------------------------

Summary of changes:
 src/lib/datasrc/factory.cc          |    2 ++
 src/lib/datasrc/memory_datasrc.h    |   19 +++++++++++++++++++
 src/lib/datasrc/sqlite3_accessor.cc |    2 +-
 src/lib/datasrc/sqlite3_accessor.h  |    8 ++++++++
 4 files changed, 30 insertions(+), 1 deletions(-)

-----------------------------------------------------------------------
diff --git a/src/lib/datasrc/factory.cc b/src/lib/datasrc/factory.cc
index 3126a04..e464c89 100644
--- a/src/lib/datasrc/factory.cc
+++ b/src/lib/datasrc/factory.cc
@@ -19,6 +19,8 @@
 #include "sqlite3_accessor.h"
 #include "memory_datasrc.h"
 
+#include <datasrc/logger.h>
+
 #include <dlfcn.h>
 
 using namespace isc::data;
diff --git a/src/lib/datasrc/memory_datasrc.h b/src/lib/datasrc/memory_datasrc.h
index 6f15b83..4a6641d 100644
--- a/src/lib/datasrc/memory_datasrc.h
+++ b/src/lib/datasrc/memory_datasrc.h
@@ -286,8 +286,27 @@ private:
     InMemoryClientImpl* impl_;
 };
 
+/// \brief Creates an instance of the Memory datasource client
+///
+/// Currently the configuration passed here must be a MapElement, formed as
+/// follows:
+/// \code
+/// { "type": string ("memory"),
+///   "class": string ("IN"/"CH"/etc),
+///   "zones": list
+/// }
+/// Zones list is a list of maps:
+/// { "origin": string,
+///   "file": string
+/// }
+/// \endcode
+/// (i.e. the configuration that was used prior to the datasource refactor)
+///
+/// This configuration setup is currently under discussion and will change in
+/// the near future.
 extern "C" DataSourceClient* createInstance(isc::data::ConstElementPtr config);
 
+/// \brief Destroy the instance created by createInstance()
 extern "C" void destroyInstance(DataSourceClient* instance);
 
 
diff --git a/src/lib/datasrc/sqlite3_accessor.cc b/src/lib/datasrc/sqlite3_accessor.cc
index 863da10..5ee58d4 100644
--- a/src/lib/datasrc/sqlite3_accessor.cc
+++ b/src/lib/datasrc/sqlite3_accessor.cc
@@ -674,7 +674,7 @@ addError(ElementPtr errors, const std::string& error) {
 bool
 checkConfig(ConstElementPtr config, ElementPtr errors) {
     /* Specific configuration is under discussion, right now this accepts
-     * the 'old' configuration, see [TODO]
+     * the 'old' configuration, see header file
      */
     bool result = true;
 
diff --git a/src/lib/datasrc/sqlite3_accessor.h b/src/lib/datasrc/sqlite3_accessor.h
index 04c5377..6a77a63 100644
--- a/src/lib/datasrc/sqlite3_accessor.h
+++ b/src/lib/datasrc/sqlite3_accessor.h
@@ -189,8 +189,16 @@ private:
     const std::string database_name_;
 };
 
+/// \brief Creates an instance of the SQlite3 datasource client
+///
+/// Currently the configuration passed here must be a MapElement, containing
+/// one item called "database_file", whose value is a string
+///
+/// This configuration setup is currently under discussion and will change in
+/// the near future.
 extern "C" DataSourceClient* createInstance(isc::data::ConstElementPtr config);
 
+/// \brief Destroy the instance created by createInstance()
 extern "C" void destroyInstance(DataSourceClient* instance);
 
 }