X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2ca35a707044d033c33cb4f016e6ffddfded0d05..ccae9b178683382c85fbb8aaddfbc6d791c70f78:/src/s4u/s4u_mutex.cpp

diff --git a/src/s4u/s4u_mutex.cpp b/src/s4u/s4u_mutex.cpp
index ba83148c58..4f2cce6deb 100644
--- a/src/s4u/s4u_mutex.cpp
+++ b/src/s4u/s4u_mutex.cpp
@@ -13,21 +13,31 @@
 namespace simgrid {
 namespace s4u {
 
+/** @brief Blocks the calling actor until the mutex can be obtained */
 void Mutex::lock()
 {
   simcall_mutex_lock(mutex_);
 }
 
+/** @brief Release the ownership of the mutex, unleashing a blocked actor (if any)
+ *
+ * Will fail if the calling actor does not own the mutex.
+ */
 void Mutex::unlock()
 {
   simcall_mutex_unlock(mutex_);
 }
 
+/** @brief Acquire the mutex if it's free, and return false (without blocking) if not */
 bool Mutex::try_lock()
 {
   return simcall_mutex_trylock(mutex_);
 }
 
+/** @brief Create a new mutex
+ *
+ * See @ref s4u_raii.
+ */
 MutexPtr Mutex::createMutex()
 {
   smx_mutex_t mutex = simcall_mutex_init();