From: Marcin Siodelski <marcin@isc.org>
Date: Wed, 5 Sep 2018 10:23:26 +0000 (+0200)
Subject: [#28,!20] Added commentary to BaseConfigBackend class.
X-Git-Tag: 134-bugs--xcode-10_base~21
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4d386aa1c14117a68e10a81281a4f64db2a1584a;p=thirdparty%2Fkea.git

[#28,!20] Added commentary to BaseConfigBackend class.
---

diff --git a/src/lib/config_backend/base_config_backend.h b/src/lib/config_backend/base_config_backend.h
index 0ca6671269..b92d2079be 100644
--- a/src/lib/config_backend/base_config_backend.h
+++ b/src/lib/config_backend/base_config_backend.h
@@ -14,20 +14,34 @@
 namespace isc {
 namespace cb {
 
+/// @brief Base class for server specific configuration backends.
 class BaseConfigBackend {
 public:
 
+    /// @brief Virtual destructor.
+    virtual ~BaseConfigBackend() { }
 
-    virtual ~BaseConfigBackend() {
-    }
-
+    /// @brief Returns backend type in the textual format.
     virtual std::string getType() const = 0;
 
+    /// @brief Returns backend host.
+    ///
+    /// This is used by the @c BaseConfigBackendPool to select backend
+    /// when @c BackendSelector is specified.
+    ///
+    /// @return host on which the database is located.
     virtual std::string getHost() const = 0;
 
+    /// @brief Returns backend port number.
+    ///
+    /// This is used by the @c BaseConfigBackendPool to select backend
+    /// when @c BackendSelector is specified.
+    ///
+    /// @return Port number on which database service is available.
     virtual uint16_t getPort() const = 0;
 };
 
+/// @brief Shared pointer to the @c BaseConfigBackend.
 typedef boost::shared_ptr<BaseConfigBackend> BaseConfigBackendPtr;
 
 } // end of namespace isc::cb