[s4u] Add basic documentation on ConditionVariable

diff --git a/include/simgrid/s4u/conditionVariable.hpp b/include/simgrid/s4u/conditionVariable.hpp
index 2858244..0c34c92 100644 (file)
--- a/include/simgrid/s4u/conditionVariable.hpp
+++ b/include/simgrid/s4u/conditionVariable.hpp
@@ -18,6 +18,12 @@ namespace s4u {
 
 class Mutex;
 
 
 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:
 XBT_PUBLIC_CLASS ConditionVariable {
   
 public: