X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/04fa61785ae1ecb5e5233ef0cb6d24145120d95e..acd555b41f9a71f6e3ed538f00d1e84fe6d19024:/include/simgrid/s4u/Mutex.hpp

diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp
index 0b3ebc8c59..9e8e317e72 100644
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -20,21 +20,24 @@ namespace s4u {
 class ConditionVariable;
 
 /** @brief A classical mutex, but blocking in the simulation world
+ *  @ingroup s4u_api
  *
- * It is strictly impossible to use a real mutex (such as
- * [std::mutex](http://en.cppreference.com/w/cpp/thread/mutex)
- * or [pthread_mutex_t](http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html)),
+ * It is strictly impossible to use a real mutex, such as
+ * <a href="http://en.cppreference.com/w/cpp/thread/mutex">std::mutex</a>
+ * or <a href="http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html">pthread_mutex_t</a>,
  * because it would block the whole simulation.
  * Instead, you should use the present class, that is a drop-in replacement of
- * [std::mutex](http://en.cppreference.com/w/cpp/thread/mutex).
+ * <a href="http://en.cppreference.com/w/cpp/thread/mutex>std::mutex</a>.
+ *
+ * As for any S4U object, Mutexes are using the @ref s4u_raii "RAII idiom" for memory management.
+ * Use createMutex() to get a ::MutexPtr to a newly created mutex and only manipulate ::MutexPtr.
  *
  */
 XBT_PUBLIC_CLASS Mutex {
-friend ConditionVariable;
-private:
-  friend simgrid::simix::Mutex;
-  simgrid::simix::Mutex* mutex_;
-  Mutex(simgrid::simix::Mutex* mutex) : mutex_(mutex) {}
+  friend ConditionVariable;
+  friend simgrid::simix::MutexImpl;
+  simgrid::simix::MutexImpl* mutex_;
+  explicit Mutex(simgrid::simix::MutexImpl * mutex) : mutex_(mutex) {}
 
   /* refcounting of the intrusive_ptr is delegated to the implementation object */
   friend void intrusive_ptr_add_ref(Mutex* mutex)
@@ -59,7 +62,6 @@ public:
   /** Constructs a new mutex */
   static Ptr createMutex();
 
-public:
   void lock();
   void unlock();
   bool try_lock();