From 4f34c56e7c9e576d43882fab256e12e013f7c8ff Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Wed, 25 Jul 2018 12:56:12 +0800 Subject: [PATCH] common/config_proxy: document Config{Values,Proxy} Signed-off-by: Kefu Chai --- src/common/config_proxy.h | 3 +++ src/common/config_values.h | 3 +++ 2 files changed, 6 insertions(+) diff --git a/src/common/config_proxy.h b/src/common/config_proxy.h index af4e48c0f40..2bcc7a44e6c 100644 --- 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 b21bfb43426..b5f10b6cb47 100644 --- 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>; values_t values; -- 2.39.5