aboutsummaryrefslogtreecommitdiff
path: root/src/expected.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/expected.hpp
parent7b940a39dfef6f19846fe357d4a5167c66c79e85 (diff)
downloadwanda-d3e691c9200b7b782c8acf17468068a699588a73.tar.xz
wanda-d3e691c9200b7b782c8acf17468068a699588a73.zip
doc: update documentation
Diffstat (limited to 'src/expected.hpp')
-rw-r--r--src/expected.hpp9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/expected.hpp b/src/expected.hpp
index 4555d92..fff0d81 100644
--- a/src/expected.hpp
+++ b/src/expected.hpp
@@ -1,3 +1,9 @@
+/**
+ * @file expected.hpp
+ * @author Felix Morgner (felix.morgner@gmail.com)
+ * @since 1.0.0
+ */
+
#ifndef WANDA_EXPECTED_HPP
#define WANDA_EXPECTED_HPP
@@ -7,6 +13,9 @@
namespace wanda
{
+ /**
+ * @brief A type to represent the error case of a computation based on #wanda::expected
+ */
template<typename ErrorType>
struct unexpected
{