From d2a70c247fd8625d8bd226527e9a75d88ce8838b Mon Sep 17 00:00:00 2001 From: Christian Kern Date: Wed, 4 Nov 2015 14:46:45 +0100 Subject: [PATCH] Document returning error, even if currently this never happens (future use + stay compatible with mutex implementation). --- base_c/include/embb/base/c/mutex.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/base_c/include/embb/base/c/mutex.h b/base_c/include/embb/base/c/mutex.h index f3c8450..1214e39 100644 --- a/base_c/include/embb/base/c/mutex.h +++ b/base_c/include/embb/base/c/mutex.h @@ -180,7 +180,8 @@ int embb_spin_init( * * \pre \c spinlock is initialized \n * \post If successful, \c spinlock is locked. - * \return EMBB_SUCCESS if spinlock could be locked. + * \return EMBB_SUCCESS if spinlock could be locked. \n + * EMBB_ERROR if an error occurred. * \threadsafe * \see embb_spinlock_try_lock(), embb_mutex_unlock() */ @@ -197,6 +198,7 @@ int embb_spin_lock( * * \return EMBB_SUCCESS if spinlock could be locked \n * EMBB_BUSY if spinlock could not be locked \n + * EMBB_ERROR if an error occurred * \threadsafe * \see embb_spin_lock(), embb_spin_unlock() */ -- libgit2 0.26.0