Parcourir la source

[2281] Add documentation for the static datasource shared object's public symbols

Mukund Sivaraman il y a 12 ans
Parent
commit
cfd00e9403
1 fichiers modifiés avec 11 ajouts et 0 suppressions
  1. 11 0
      src/lib/datasrc/static_datasrc.h

+ 11 - 0
src/lib/datasrc/static_datasrc.h

@@ -24,9 +24,20 @@
 namespace isc {
 namespace datasrc {
 
+/// \brief Creates an instance of the static datasource client
+///
+/// Currently the configuration passed here must be a StringElement,
+/// containing the path to a zone file for the BIND./CH zone.
+///
+/// \param config The configuration for the datasource instance (see above)
+/// \param error This string will be set to an error message if an error occurs
+///              during initialization
+/// \return An instance of the static datasource client, or NULL if there was
+///         an error
 extern "C" DataSourceClient* createInstance(isc::data::ConstElementPtr config,
                                             std::string& error);
 
+/// \brief Destroy the instance created by createInstance()
 extern "C" void destroyInstance(DataSourceClient* instance);
 
 }