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 4230a98..ae785f4 100644 (file)
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -29,8 +29,10 @@ class ConditionVariable;
  *
  */
 class XBT_PUBLIC Mutex {
+#ifndef DOXYGEN
   friend ConditionVariable;
   friend simgrid::kernel::activity::MutexImpl;
+#endif
   simgrid::kernel::activity::MutexImpl* pimpl_;
   explicit Mutex(simgrid::kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
 
@@ -48,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;