From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Mon, 20 Jun 2016 10:42:01 +0000 (+0200)
Subject: [xbt] Comment about xbt::Result
X-Git-Tag: v3_14~937
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/b0ffeb85dcd9b23d14bf0eaad4077daee4e50579

[xbt] Comment about xbt::Result
---

diff --git a/include/xbt/future.hpp b/include/xbt/future.hpp
index aa559db2a7..7211c4ec77 100644
--- a/include/xbt/future.hpp
+++ b/include/xbt/future.hpp
@@ -20,9 +20,12 @@
 namespace simgrid {
 namespace xbt {
 
-/** A value or an exception
+/** A value or an exception (or nothing)
  *
- *  The API is similar to the one of future and promise.
+ *  This is similar to optional<expected<T>> but it with a Future/Promise
+ *  like API.
+ *
+ *  Also the name it not so great.
  **/
 template<class T>
 class Result {