From 64f54304277fe362448254234f6fb74578862d57 Mon Sep 17 00:00:00 2001 From: gereon Date: Sun, 9 Dec 2012 15:02:02 +0100 Subject: [PATCH] documented CallbackType --- src/utility/settings.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/utility/settings.h b/src/utility/settings.h index 49ddda8d9..163dc9376 100644 --- a/src/utility/settings.h +++ b/src/utility/settings.h @@ -131,7 +131,17 @@ namespace settings { */ typedef bool(*CheckerCallback)(bpo::variables_map&); - enum CallbackType { CB_CONFIG, CB_CLI, CB_GENERIC }; + /*! + * @brief This enums specifies the three types of options. + */ + enum CallbackType { + //! Option can be set in config file + CB_CONFIG, + //! Option can be set on command line + CB_CLI, + //! Option can be set in config file and command line + CB_GENERIC + }; /*! * @brief This class handles callbacks for registering new options and