Merge branch 'embb567_documentation_condition_variable' into development

base_c/include/embb/base/c/condition_variable.h

@@ -110,6 +110,9 @@ int embb_condition_notify_all(
  * \threadsafe
  * \see embb_condition_notify_one(), embb_condition_notify_all(),
  *      embb_condition_wait_until(), embb_condition_wait_for()
+ * \note It is strongly recommended checking the condition in a loop in order
+ *       to deal with spurious wakeups and situations where another thread has
+ *       locked the mutex between notification and wakeup.
  */
 int embb_condition_wait(
   embb_condition_t* condition_var,
@@ -131,6 +134,9 @@ int embb_condition_wait(
  * \threadsafe
  * \see embb_condition_notify_one(), embb_condition_notify_all(),
  *      embb_condition_wait(), embb_condition_wait_for()
+ * \note It is strongly recommended checking the condition in a loop in order
+ *       to deal with spurious wakeups and situations where another thread has
+ *       locked the mutex between notification and wakeup.
  */
 int embb_condition_wait_until(
   embb_condition_t* condition_var,
@@ -154,6 +160,9 @@ int embb_condition_wait_until(
  * \threadsafe
  * \see embb_condition_notify_one(), embb_condition_notify_all(),
  *      embb_condition_wait(), embb_condition_wait_until()
+ * \note It is strongly recommended checking the condition in a loop in order
+ *       to deal with spurious wakeups and situations where another thread has
+ *       locked the mutex between notification and wakeup.
  */
 int embb_condition_wait_for(
   embb_condition_t* condition_var,

base_cpp/include/embb/base/condition_variable.h

@@ -99,6 +99,10 @@ class ConditionVariable {
    * \threadsafe
    *
    * \see NotifyOne(), NotifyAll()
+   *
+   * \note It is strongly recommended checking the condition in a loop in order
+   *       to deal with spurious wakeups and situations where another thread has
+   *       locked the mutex between notification and wakeup.
    */
   void Wait(
     UniqueLock<Mutex>& lock
@@ -118,6 +122,10 @@ class ConditionVariable {
    * \throws embb::base::ErrorException if an error occurred
    *
    * \threadsafe
+   *
+   * \note It is strongly recommended checking the condition in a loop in order
+   *       to deal with spurious wakeups and situations where another thread has
+   *       locked the mutex between notification and wakeup.
    */
   bool WaitUntil(
     UniqueLock<Mutex>& lock,
@@ -141,6 +149,10 @@ class ConditionVariable {
    * \threadsafe
    *
    * \tparam Tick Type of tick of the duration. See Duration.
+   *
+   * \note It is strongly recommended checking the condition in a loop in order
+   *       to deal with spurious wakeups and situations where another thread has
+   *       locked the mutex between notification and wakeup.
    */
   template<typename Tick>
   bool WaitFor(