From: richardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Date: Sat, 5 Mar 2011 17:47:53 +0000 (+0000)
Subject: Minor comment addition to queue.h.
X-Git-Tag: V7.0.0~33
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=be07d5ff489d28850d30ca3cc34ff4612c74671f;p=freertos

Minor comment addition to queue.h.

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

diff --git a/Source/include/queue.h b/Source/include/queue.h
index c199573c5..f9d7bfa78 100644
--- a/Source/include/queue.h
+++ b/Source/include/queue.h
@@ -68,7 +68,11 @@ extern "C" {
 
 #include "mpu_wrappers.h"
 
-
+/**
+ * Type by which queues are referenced.  For example, a call to xQueueCreate
+ * returns (via a pointer parameter) an xQueueHandle variable that can then
+ * be used as a parameter to xQueueSend(), xQueueReceive(), etc.
+ */
 typedef void * xQueueHandle;
 
 
@@ -140,7 +144,7 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
  * <pre>
  portBASE_TYPE xQueueSendToToFront(
 								   xQueueHandle	xQueue,
-								   const	void	*	pvItemToQueue,
+								   const void	*	pvItemToQueue,
 								   portTickType	xTicksToWait
 							   );
  * </pre>