From d3e691c9200b7b782c8acf17468068a699588a73 Mon Sep 17 00:00:00 2001
From: Felix Morgner <felix.morgner@gmail.com>
Date: Mon, 10 Dec 2018 09:25:14 +0100
Subject: doc: update documentation

---
 src/setting.hpp | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/setting.hpp')

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)
       {
-- 
cgit v1.2.3