Merge branch 'xbt_random' into 'master'

[simgrid.git] / include / simgrid / s4u / Barrier.hpp

diff --git a/include/simgrid/s4u/Barrier.hpp b/include/simgrid/s4u/Barrier.hpp
index 85e2c05..db8e05e 100644 (file)
--- a/include/simgrid/s4u/Barrier.hpp
+++ b/include/simgrid/s4u/Barrier.hpp
@@ -6,16 +6,15 @@
 #ifndef SIMGRID_S4U_BARRIER_HPP
 #define SIMGRID_S4U_BARRIER_HPP
 
+#include <simgrid/barrier.h>
+#include <simgrid/chrono.hpp>
 #include <simgrid/forward.h>
 #include <simgrid/s4u/ConditionVariable.hpp>
-#include <simgrid/chrono.hpp>
 #include <simgrid/s4u/Mutex.hpp>
 
 #include <atomic>
 #include <future>
 
-constexpr int SG_BARRIER_SERIAL_THREAD = -1;
-
 namespace simgrid {
 namespace s4u {
 
@@ -30,14 +29,17 @@ private:
   std::atomic_int_fast32_t refcount_{0};
 
 public:
+  /** Creates a barrier for the given amount of actors */
   explicit Barrier(unsigned int count);
-  ~Barrier()              = default;
 #ifndef DOXYGEN
+  ~Barrier()              = default;
   Barrier(Barrier const&) = delete;
   Barrier& operator=(Barrier const&) = delete;
 #endif
 
+  /** Creates a barrier for the given amount of actors */
   static BarrierPtr create(unsigned int expected_actors);
+  /** Blocks into the barrier. Every waiting actors will be unlocked once the expected amount of actors reaches the barrier */
   int wait();
 
 #ifndef DOXYGEN