improve doxygen comments in s4u

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

diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp
index 81263d9..ae785f4 100644 (file)
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2018. 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,13 +6,8 @@
 #ifndef SIMGRID_S4U_MUTEX_HPP
 #define SIMGRID_S4U_MUTEX_HPP
 
-#include <mutex>
-#include <utility>
-
-#include <boost/intrusive_ptr.hpp>
-
-#include <xbt/base.h>
-#include "simgrid/simix.h"
+#include <simgrid/forward.h>
+#include <xbt/asserts.h>
 
 namespace simgrid {
 namespace s4u {
@@ -33,23 +28,18 @@ class ConditionVariable;
  * Use createMutex() to get a ::MutexPtr to a newly created mutex and only manipulate ::MutexPtr.
  *
  */
-XBT_PUBLIC_CLASS Mutex {
+class XBT_PUBLIC Mutex {
+#ifndef DOXYGEN
   friend ConditionVariable;
   friend simgrid::kernel::activity::MutexImpl;
-  simgrid::kernel::activity::MutexImpl* mutex_;
-  explicit Mutex(simgrid::kernel::activity::MutexImpl * mutex) : mutex_(mutex) {}
+#endif
+  simgrid::kernel::activity::MutexImpl* pimpl_;
+  explicit Mutex(simgrid::kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
+
+  /* refcounting */
+  friend XBT_PUBLIC void intrusive_ptr_add_ref(Mutex* mutex);
+  friend XBT_PUBLIC void intrusive_ptr_release(Mutex* mutex);
 
-  /* refcounting of the intrusive_ptr is delegated to the implementation object */
-  friend void intrusive_ptr_add_ref(Mutex* mutex)
-  {
-    xbt_assert(mutex);
-    SIMIX_mutex_ref(mutex->mutex_);
-  }
-  friend void intrusive_ptr_release(Mutex* mutex)
-  {
-    xbt_assert(mutex);
-    SIMIX_mutex_unref(mutex->mutex_);
-  }
 public:
   using Ptr = boost::intrusive_ptr<Mutex>;
 
@@ -60,11 +50,15 @@ public:
   Mutex& operator=(Mutex const&) = delete;
 
   /** Constructs a new mutex */
-  static Ptr createMutex();
+  static Ptr create();
 
   void lock();
   void unlock();
   bool try_lock();
+
+  // deprecated
+  /** @deprecated Mutex::create() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mutex::create()") static Ptr createMutex() { return create(); }
 };
 
 using MutexPtr = Mutex::Ptr;