]> git.sur5r.net Git - freertos/commitdiff
Minor comment addition to queue.h.
authorrichardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Sat, 5 Mar 2011 17:47:53 +0000 (17:47 +0000)
committerrichardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Sat, 5 Mar 2011 17:47:53 +0000 (17:47 +0000)
git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@1316 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

Source/include/queue.h

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