Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[xbt] Update comment on xbt::fulfillPromise
authorGabriel Corona <gabriel.corona@loria.fr>
Fri, 3 Jun 2016 14:51:06 +0000 (16:51 +0200)
committerGabriel Corona <gabriel.corona@loria.fr>
Fri, 3 Jun 2016 14:51:06 +0000 (16:51 +0200)
include/xbt/future.hpp

index 316f68f..81c8845 100644 (file)
@@ -171,7 +171,14 @@ public:
   }
 };
 
-/** Fulfill a promise by executing a given code */
+/** Execute some code and set a promise or result accordingly
+ *
+ *  We might need this when working with generic code because
+ *  the trivial implementation does not work with void (before C++1z).
+ *
+ *  @param    code  What we want to do
+ *  @param  promise Where to want to store the result
+ */
 template<class R, class F>
 auto fulfillPromise(R& promise, F&& code)
 -> decltype(promise.set_value(code()))
@@ -184,11 +191,6 @@ auto fulfillPromise(R& promise, F&& code)
   }
 }
 
-/** Fulfill a promise by executing a given code
- *
- *  This is a special version for `std::promise<void>` because the default
- *  version does not compile in this case.
- */
 template<class P, class F>
 auto fulfillPromise(P& promise, F&& code)
 -> decltype(promise.set_value())