From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Tue, 21 Jun 2016 09:33:30 +0000 (+0200)
Subject: [s4u] Add basic documentation on ConditionVariable
X-Git-Tag: v3_14~906
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/b85171d8365dd0910d630bdb98b53a18c103a4ce?ds=sidebyside

[s4u] Add basic documentation on ConditionVariable
---

diff --git a/include/simgrid/s4u/conditionVariable.hpp b/include/simgrid/s4u/conditionVariable.hpp
index 2858244ef6..0c34c9284f 100644
--- a/include/simgrid/s4u/conditionVariable.hpp
+++ b/include/simgrid/s4u/conditionVariable.hpp
@@ -18,6 +18,12 @@ namespace s4u {
 
 class Mutex;
 
+/** A condition variable
+ *
+ *  This is based on std::condition_variable and should respect the same
+ *  semantic. But we currently use (only) double for both durations and
+ *  timestamp timeouts.
+ */
 XBT_PUBLIC_CLASS ConditionVariable {
   
 public: