aboutsummaryrefslogtreecommitdiff
path: root/src/setting.hpp
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@gmail.com>2018-12-10 09:25:14 +0100
committerFelix Morgner <felix.morgner@gmail.com>2018-12-10 09:25:14 +0100
commitd3e691c9200b7b782c8acf17468068a699588a73 (patch)
tree44f179ebf773dc8536b220f2ffcc3d2eec374aa4 /src/setting.hpp
parent7b940a39dfef6f19846fe357d4a5167c66c79e85 (diff)
downloadwanda-d3e691c9200b7b782c8acf17468068a699588a73.tar.xz
wanda-d3e691c9200b7b782c8acf17468068a699588a73.zip
doc: update documentation
Diffstat (limited to 'src/setting.hpp')
-rw-r--r--src/setting.hpp8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/setting.hpp b/src/setting.hpp
index 997109a..b681e05 100644
--- a/src/setting.hpp
+++ b/src/setting.hpp
@@ -52,8 +52,16 @@ namespace wanda
{
using value_type = std::variant<std::monostate, bool, std::int32_t, std::int64_t, std::uint32_t, std::uint64_t, double, std::string, std::vector<std::string>>;
+ /**
+ * @brief Get the value of the settings entry
+ */
value_type operator*() const;
+ /**
+ * @brief Assign the given @p value to the settings entry
+ *
+ * @returns @p true iff. the value could be successfully assigned
+ */
template<typename Type>
bool operator=(Type value)
{