doxygen: uniformity in command markers (@ vs. \)

[simgrid.git] / src / kernel / activity / ConditionVariableImpl.cpp

diff --git a/src/kernel/activity/ConditionVariableImpl.cpp b/src/kernel/activity/ConditionVariableImpl.cpp
index 2ed96a7..ddd34cd 100644 (file)
--- a/src/kernel/activity/ConditionVariableImpl.cpp
+++ b/src/kernel/activity/ConditionVariableImpl.cpp
@@ -11,13 +11,32 @@
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ConditionVariable, simix_synchro, "Condition variables");
 
+/********************************* Condition **********************************/
+
 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout, smx_actor_t issuer,
-                             smx_simcall_t simcall);
+                             smx_simcall_t simcall)
+{
+  XBT_IN("(%p, %p, %f, %p,%p)", cond, mutex, timeout, issuer, simcall);
+  smx_activity_t synchro = nullptr;
 
-/********************************* Condition **********************************/
+  XBT_DEBUG("Wait condition %p", cond);
+
+  /* If there is a mutex unlock it */
+  /* FIXME: what happens if the issuer is not the owner of the mutex? */
+  if (mutex != nullptr) {
+    cond->mutex = mutex;
+    mutex->unlock(issuer);
+  }
+
+  synchro = SIMIX_synchro_wait(issuer->host_, timeout);
+  synchro->simcalls_.push_front(simcall);
+  issuer->waiting_synchro = synchro;
+  cond->sleeping.push_back(*simcall->issuer);
+  XBT_OUT();
+}
 
 /**
- * \brief Handle a condition waiting simcall without timeouts
+ * @brief Handle a condition waiting simcall without timeouts
  */
 void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
 {
@@ -29,39 +48,17 @@ void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex
 }
 
 /**
- * \brief Handle a condition waiting simcall with timeouts
+ * @brief Handle a condition waiting simcall with timeouts
  */
 void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex, double timeout)
 {
   XBT_IN("(%p)", simcall);
   smx_actor_t issuer = simcall->issuer;
-
+  simcall_cond_wait_timeout__set__result(simcall, 0); // default result, will be set to 1 on timeout
   _SIMIX_cond_wait(cond, mutex, timeout, issuer, simcall);
   XBT_OUT();
 }
 
-static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout, smx_actor_t issuer,
-                             smx_simcall_t simcall)
-{
-  XBT_IN("(%p, %p, %f, %p,%p)", cond, mutex, timeout, issuer, simcall);
-  smx_activity_t synchro = nullptr;
-
-  XBT_DEBUG("Wait condition %p", cond);
-
-  /* If there is a mutex unlock it */
-  /* FIXME: what happens if the issuer is not the owner of the mutex? */
-  if (mutex != nullptr) {
-    cond->mutex = mutex;
-    mutex->unlock(issuer);
-  }
-
-  synchro = SIMIX_synchro_wait(issuer->host, timeout);
-  synchro->simcalls.push_front(simcall);
-  issuer->waiting_synchro = synchro;
-  cond->sleeping.push_back(*simcall->issuer);
-  XBT_OUT();
-}
-
 namespace simgrid {
 namespace kernel {
 namespace activity {
@@ -70,7 +67,7 @@ ConditionVariableImpl::ConditionVariableImpl() : cond_(this) {}
 ConditionVariableImpl::~ConditionVariableImpl() = default;
 
 /**
- * \brief Signalizes a condition.
+ * @brief Signalizes a condition.
  *
  * Signalizes a condition and wakes up a sleeping process.
  * If there are no process sleeping, no action is done.
@@ -103,7 +100,7 @@ void ConditionVariableImpl::signal()
 }
 
 /**
- * \brief Broadcasts a condition.
+ * @brief Broadcasts a condition.
  *
  * Signal ALL processes waiting on a condition.
  * If there are no process waiting, no action is done.