Update comments only.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@535 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

diff --git a/Source/include/queue.h b/Source/include/queue.h
index 5e5d162d7f59eb3bd0248e523485d28b78a522d9..3ccae302a9d095424a9cbbd21376137cc93dabbf 100644 (file)
--- a/Source/include/queue.h
+++ b/Source/include/queue.h
@@ -151,9 +151,9 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
  *\r
  * @param xTicksToWait The maximum amount of time the task should block\r
  * waiting for space to become available on the queue, should it already\r
- * be full.  The call will return immediately if this is set to 0.  The\r
- * time is defined in tick periods so the constant portTICK_RATE_MS\r
- * should be used to convert to real time if this is required.\r
+ * be full.  The call will return immediately if this is set to 0 and the\r
+ * queue is full.  The time is defined in tick periods so the constant \r
+ * portTICK_RATE_MS should be used to convert to real time if this is required.\r
  *\r
  * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
  *\r
@@ -233,9 +233,9 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
  *\r
  * @param xTicksToWait The maximum amount of time the task should block\r
  * waiting for space to become available on the queue, should it already\r
- * be full.  The call will return immediately if this is set to 0.  The\r
- * time is defined in tick periods so the constant portTICK_RATE_MS\r
- * should be used to convert to real time if this is required.\r
+ * be full.  The call will return immediately if this is set to 0 and the queue\r
+ * is full.  The  time is defined in tick periods so the constant \r
+ * portTICK_RATE_MS should be used to convert to real time if this is required.\r
  *\r
  * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
  *\r
@@ -317,9 +317,9 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
  *\r
  * @param xTicksToWait The maximum amount of time the task should block\r
  * waiting for space to become available on the queue, should it already\r
- * be full.  The call will return immediately if this is set to 0.  The\r
- * time is defined in tick periods so the constant portTICK_RATE_MS\r
- * should be used to convert to real time if this is required.\r
+ * be full.  The call will return immediately if this is set to 0 and the\r
+ * queue is full.  The time is defined in tick periods so the constant \r
+ * portTICK_RATE_MS should be used to convert to real time if this is required.\r
  *\r
  * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
  *\r
@@ -401,9 +401,9 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
  *\r
  * @param xTicksToWait The maximum amount of time the task should block\r
  * waiting for space to become available on the queue, should it already\r
- * be full.  The call will return immediately if this is set to 0.  The\r
- * time is defined in tick periods so the constant portTICK_RATE_MS\r
- * should be used to convert to real time if this is required.\r
+ * be full.  The call will return immediately if this is set to 0 and the\r
+ * queue is full.  The time is defined in tick periods so the constant \r
+ * portTICK_RATE_MS should be used to convert to real time if this is required.\r
  *\r
  * @param xCopyPosition Can take the value queueSEND_TO_BACK to place the\r
  * item at the back of the queue, or queueSEND_TO_FRONT to place the item\r
@@ -492,6 +492,8 @@ signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const
  * waiting for an item to receive should the queue be empty at the time\r
  * of the call.    The time is defined in tick periods so the constant\r
  * portTICK_RATE_MS should be used to convert to real time if this is required.\r
+ * xQueuePeek() will return immediately if xTicksToWait is 0 and the queue\r
+ * is empty.\r
  *\r
  * @return pdTRUE if an item was successfully received from the queue,\r
  * otherwise pdFALSE.\r
@@ -581,8 +583,10 @@ signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const
  *\r
  * @param xTicksToWait The maximum amount of time the task should block\r
  * waiting for an item to receive should the queue be empty at the time\r
- * of the call.    The time is defined in tick periods so the constant\r
- * portTICK_RATE_MS should be used to convert to real time if this is required.\r
+ * of the call.    xQueueReceive() will return immediately if xTicksToWait\r
+ * is zero and the queue is empty.  The time is defined in tick periods so the \r
+ * constant portTICK_RATE_MS should be used to convert to real time if this is \r
+ * required.\r
  *\r
  * @return pdTRUE if an item was successfully received from the queue,\r
  * otherwise pdFALSE.\r
@@ -675,6 +679,8 @@ signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const
  * waiting for an item to receive should the queue be empty at the time\r
  * of the call.    The time is defined in tick periods so the constant\r
  * portTICK_RATE_MS should be used to convert to real time if this is required.\r
+ * xQueueGenericReceive() will return immediately if the queue is empty and\r
+ * xTicksToWait is 0.\r
  *\r
  * @param xJustPeek When set to true, the item received from the queue is not\r
  * actually removed from the queue - meaning a subsequent call to\r