X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8bff32bae7e7bcd9c20695dc02666e6c450a0bdc..e04e3ae8fec7cb28eef7705e4aebf2370e6fdd6a:/include/simgrid/s4u/Barrier.hpp

diff --git a/include/simgrid/s4u/Barrier.hpp b/include/simgrid/s4u/Barrier.hpp
index b225d9f772..db8e05e830 100644
--- a/include/simgrid/s4u/Barrier.hpp
+++ b/include/simgrid/s4u/Barrier.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2018-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,9 +6,10 @@
 #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>
@@ -21,28 +22,33 @@ class XBT_PUBLIC Barrier {
 private:
   MutexPtr mutex_;
   ConditionVariablePtr cond_;
-  unsigned int expected_processes_;
-  unsigned int arrived_processes_ = 0;
+  unsigned int expected_actors_;
+  unsigned int arrived_actors_ = 0;
 
   /* refcounting */
   std::atomic_int_fast32_t refcount_{0};
 
 public:
+  /** Creates a barrier for the given amount of actors */
   explicit Barrier(unsigned int count);
+#ifndef DOXYGEN
   ~Barrier()              = default;
   Barrier(Barrier const&) = delete;
   Barrier& operator=(Barrier const&) = delete;
+#endif
 
-  /** Constructs a new barrier */
-  static BarrierPtr create(unsigned int expected_processes);
-
+  /** 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
   /* refcounting */
   friend XBT_PUBLIC void intrusive_ptr_add_ref(Barrier* barrier);
   friend XBT_PUBLIC void intrusive_ptr_release(Barrier* barrier);
+#endif
 };
-}
-} // namespace simgrid::s4u
+} // namespace s4u
+} // namespace simgrid
 
 #endif