common/config_proxy: document Config{Values,Proxy}

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/src/common/config_proxy.h b/src/common/config_proxy.h
index af4e48c0f4024ac5b9f08d7dd844ba021c77fd05..2bcc7a44e6c911ccc46c04e59edb7033ca8e99b5 100644 (file)
--- a/src/common/config_proxy.h
+++ b/src/common/config_proxy.h
@@ -9,6 +9,9 @@
 #include "common/config_obs_mgr.h"
 #include "common/Mutex.h"
 
+// @c ConfigProxy is a facade of multiple config related classes. it exposes
+// the legacy settings with arrow operator, and the new-style config with its
+// member methods.
 class ConfigProxy {
   /**
    * The current values of all settings described by the schema

diff --git a/src/common/config_values.h b/src/common/config_values.h
index b21bfb43426def9030bc201c59accdddf48792d3..b5f10b6cb47efa417f4e0f8a998d736d24772584 100644 (file)
--- a/src/common/config_values.h
+++ b/src/common/config_values.h
@@ -14,6 +14,9 @@
 #include "log/SubsystemMap.h"
 #include "msg/msg_types.h"
 
+// @c ConfigValues keeps track of mappings from the config names to their values,
+// debug logging settings, and some other "unnamed" settings, like entity name of
+// the daemon.
 class ConfigValues {
   using values_t = std::map<std::string, map<int32_t,Option::value_t>>;
   values_t values;