aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-01-04 20:55:32 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-01-04 20:55:32 +0000
commit7076a879620e2f372e133686c1c59623e379b10c (patch)
treeb998746985a4d38dbfe84589d153f3a54b52b62d
parent24cb881726f09c6bccba471b40bde76dc27036c7 (diff)
downloadChibiOS-7076a879620e2f372e133686c1c59623e379b10c.tar.gz
ChibiOS-7076a879620e2f372e133686c1c59623e379b10c.tar.bz2
ChibiOS-7076a879620e2f372e133686c1c59623e379b10c.zip
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2581 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--os/kernel/include/chqueues.h4
-rw-r--r--os/kernel/src/chqueues.c4
2 files changed, 6 insertions, 2 deletions
diff --git a/os/kernel/include/chqueues.h b/os/kernel/include/chqueues.h
index 76a0b63a5..5a11ec7cc 100644
--- a/os/kernel/include/chqueues.h
+++ b/os/kernel/include/chqueues.h
@@ -205,7 +205,7 @@ typedef GenericQueue OutputQueue;
*
* @iclass
*/
-#define chOQIsEmptyI(q) ((bool_t)(chQSpaceI(q) >= chQSizeI(q)))
+#define chOQIsEmptyI(oqp) ((bool_t)(chQSpaceI(q) >= chQSizeI(q)))
/**
* @brief Evaluates to @p TRUE if the specified output queue is full.
@@ -217,7 +217,7 @@ typedef GenericQueue OutputQueue;
*
* @iclass
*/
-#define chOQIsFullI(q) ((bool_t)(chQSpaceI(q) <= 0))
+#define chOQIsFullI(oqp) ((bool_t)(chQSpaceI(q) <= 0))
/**
* @brief Output queue write.
diff --git a/os/kernel/src/chqueues.c b/os/kernel/src/chqueues.c
index 4a195fa9b..8d459a7e8 100644
--- a/os/kernel/src/chqueues.c
+++ b/os/kernel/src/chqueues.c
@@ -73,6 +73,8 @@ void chIQInit(InputQueue *iqp, uint8_t *bp, size_t size, qnotify_t infy) {
* @brief Returns the filled space into an input queue.
*
* @param[in] iqp pointer to an @p InputQueue structure
+ * @return The number of bytes in the queue.
+ * @retval 0 if the queue is empty.
*
* @iclass
*/
@@ -252,6 +254,8 @@ void chOQInit(OutputQueue *oqp, uint8_t *bp, size_t size, qnotify_t onfy) {
* @brief Returns the filled space into an output queue.
*
* @param[in] oqp pointer to an @p OutputQueue structure
+ * @return The number of bytes in the queue.
+ * @retval 0 if the queue is empty.
*
* @iclass
*/