From 12b6055eca66b3472a8d1ea1f6a4423006afa593 Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Thu, 8 Oct 2015 12:57:23 +0000 Subject: Fixed small documentation errors. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@8347 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/rt/include/chbsem.h | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'os/rt') diff --git a/os/rt/include/chbsem.h b/os/rt/include/chbsem.h index 336e6925f..aa5fd7044 100644 --- a/os/rt/include/chbsem.h +++ b/os/rt/include/chbsem.h @@ -132,8 +132,8 @@ static inline void chBSemObjectInit(binary_semaphore_t *bsp, bool taken) { * @param[in] bsp pointer to a @p binary_semaphore_t structure * @return A message specifying how the invoking thread has been * released from the semaphore. - * @retval RDY_OK if the binary semaphore has been successfully taken. - * @retval RDY_RESET if the binary semaphore has been reset using + * @retval MSG_OK if the binary semaphore has been successfully taken. + * @retval MSG_RESET if the binary semaphore has been reset using * @p bsemReset(). * * @api @@ -149,8 +149,8 @@ static inline msg_t chBSemWait(binary_semaphore_t *bsp) { * @param[in] bsp pointer to a @p binary_semaphore_t structure * @return A message specifying how the invoking thread has been * released from the semaphore. - * @retval RDY_OK if the binary semaphore has been successfully taken. - * @retval RDY_RESET if the binary semaphore has been reset using + * @retval MSG_OK if the binary semaphore has been successfully taken. + * @retval MSG_RESET if the binary semaphore has been reset using * @p bsemReset(). * * @sclass @@ -173,10 +173,10 @@ static inline msg_t chBSemWaitS(binary_semaphore_t *bsp) { * . * @return A message specifying how the invoking thread has been * released from the semaphore. - * @retval RDY_OK if the binary semaphore has been successfully taken. - * @retval RDY_RESET if the binary semaphore has been reset using + * @retval MSG_OK if the binary semaphore has been successfully taken. + * @retval MSG_RESET if the binary semaphore has been reset using * @p bsemReset(). - * @retval RDY_TIMEOUT if the binary semaphore has not been signaled or reset + * @retval MSG_TIMEOUT if the binary semaphore has not been signaled or reset * within the specified timeout. * * @sclass @@ -200,10 +200,10 @@ static inline msg_t chBSemWaitTimeoutS(binary_semaphore_t *bsp, * . * @return A message specifying how the invoking thread has been * released from the semaphore. - * @retval RDY_OK if the binary semaphore has been successfully taken. - * @retval RDY_RESET if the binary semaphore has been reset using + * @retval MSG_OK if the binary semaphore has been successfully taken. + * @retval MSG_RESET if the binary semaphore has been reset using * @p bsemReset(). - * @retval RDY_TIMEOUT if the binary semaphore has not been signaled or reset + * @retval MSG_TIMEOUT if the binary semaphore has not been signaled or reset * within the specified timeout. * * @api @@ -218,7 +218,7 @@ static inline msg_t chBSemWaitTimeout(binary_semaphore_t *bsp, * @brief Reset operation on the binary semaphore. * @note The released threads can recognize they were waked up by a reset * rather than a signal because the @p bsemWait() will return - * @p RDY_RESET instead of @p RDY_OK. + * @p MSG_RESET instead of @p MSG_OK. * @note This function does not reschedule. * * @param[in] bsp pointer to a @p binary_semaphore_t structure @@ -240,7 +240,7 @@ static inline void chBSemResetI(binary_semaphore_t *bsp, bool taken) { * @brief Reset operation on the binary semaphore. * @note The released threads can recognize they were waked up by a reset * rather than a signal because the @p bsemWait() will return - * @p RDY_RESET instead of @p RDY_OK. + * @p MSG_RESET instead of @p MSG_OK. * * @param[in] bsp pointer to a @p binary_semaphore_t structure * @param[in] taken new state of the binary semaphore -- cgit v1.2.3