Documentation related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2581 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
gdisirio 2011-01-04 20:55:32 +00:00
parent 24cb881726
commit 7076a87962
2 changed files with 6 additions and 2 deletions

View File

@ -205,7 +205,7 @@ typedef GenericQueue OutputQueue;
* *
* @iclass * @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. * @brief Evaluates to @p TRUE if the specified output queue is full.
@ -217,7 +217,7 @@ typedef GenericQueue OutputQueue;
* *
* @iclass * @iclass
*/ */
#define chOQIsFullI(q) ((bool_t)(chQSpaceI(q) <= 0)) #define chOQIsFullI(oqp) ((bool_t)(chQSpaceI(q) <= 0))
/** /**
* @brief Output queue write. * @brief Output queue write.

View File

@ -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. * @brief Returns the filled space into an input queue.
* *
* @param[in] iqp pointer to an @p InputQueue structure * @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 * @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. * @brief Returns the filled space into an output queue.
* *
* @param[in] oqp pointer to an @p OutputQueue structure * @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 * @iclass
*/ */