doc improvement

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7293 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 7 insertions, 3 deletions

diff --git a/os/rt/src/chmtx.c b/os/rt/src/chmtx.c
index d4eb06d60..9099723d6 100644
--- a/os/rt/src/chmtx.c
+++ b/os/rt/src/chmtx.c
@@ -308,7 +308,9 @@ bool chMtxTryLockS(mutex_t *mp) {
 }

 

 /**

- * @brief   Unlocks the next owned mutex in reverse lock order.

+ * @brief   Unlocks the specified mutex.

+ * @note    Mutexes must be unlocked in reverse lock order. Violating this

+ *          rules will result in a panic if assertions are enabled.

  * @pre     The invoking thread <b>must</b> have at least one owned mutex.

  * @post    The mutex is unlocked and removed from the per-thread stack of

  *          owned mutexes.

@@ -382,7 +384,9 @@ void chMtxUnlock(mutex_t *mp) {
 }

 

 /**

- * @brief   Unlocks the next owned mutex in reverse lock order.

+ * @brief   Unlocks the specified mutex.

+ * @note    Mutexes must be unlocked in reverse lock order. Violating this

+ *          rules will result in a panic if assertions are enabled.

  * @pre     The invoking thread <b>must</b> have at least one owned mutex.

  * @post    The mutex is unlocked and removed from the per-thread stack of

  *          owned mutexes.

@@ -455,7 +459,7 @@ void chMtxUnlockS(mutex_t *mp) {
 }

 

 /**

- * @brief   Unlocks all the mutexes owned by the invoking thread.

+ * @brief   Unlocks all mutexes owned by the invoking thread.

  * @post    The stack of owned mutexes is emptied and all the found

  *          mutexes are unlocked.

  * @note    This function is <b>MUCH MORE</b> efficient than releasing the