diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2017-12-05 08:26:15 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2017-12-05 08:26:15 +0000 |
| commit | 19ff25ecc7972a39bebaec79180254ab8b83a12d (patch) | |
| tree | 5a0522a3e36d30c4498e10dbcff26379a0640617 /os/hal/src/hal_queues.c | |
| parent | 5c7e3608905421a847b7b6c940bf322e9f6857e4 (diff) | |
| download | ChibiOS-19ff25ecc7972a39bebaec79180254ab8b83a12d.tar.gz ChibiOS-19ff25ecc7972a39bebaec79180254ab8b83a12d.tar.bz2 ChibiOS-19ff25ecc7972a39bebaec79180254ab8b83a12d.zip | |
Fixed documentation.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11117 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/src/hal_queues.c')
| -rw-r--r-- | os/hal/src/hal_queues.c | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/os/hal/src/hal_queues.c b/os/hal/src/hal_queues.c index f038b4a55..a12382cab 100644 --- a/os/hal/src/hal_queues.c +++ b/os/hal/src/hal_queues.c @@ -213,8 +213,7 @@ void iqResetI(input_queue_t *iqp) { * @param[in] b the byte value to be written in the queue
* @return The operation status.
* @retval MSG_OK if the operation has been completed with success.
- * @retval MSG_TIMEOUT if the queue is full and the operation cannot be
- * completed.
+ * @retval MSG_TIMEOUT if the queue is full.
*
* @iclass
*/
@@ -247,7 +246,7 @@ msg_t iqPutI(input_queue_t *iqp, uint8_t b) { *
* @param[in] iqp pointer to an @p input_queue_t structure
* @return A byte value from the queue.
- * @retval MSG_TIMEOUT if the specified time expired.
+ * @retval MSG_TIMEOUT if the queue is empty.
* @retval MSG_RESET if the queue has been reset.
*
* @iclass
@@ -483,7 +482,7 @@ void oqResetI(output_queue_t *oqp) { * @param[in] b the byte value to be written in the queue
* @return The operation status.
* @retval MSG_OK if the operation succeeded.
- * @retval MSG_TIMEOUT if the specified time expired.
+ * @retval MSG_TIMEOUT if the queue is full.
* @retval MSG_RESET if the queue has been reset.
*
* @iclass
|