Minor comment addition to queue.h.

14 years ago · 0e133bc0fc
parent 553a8389cc
commit 0e133bc0fc
1 changed files with 6 additions and 2 deletions
--- 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;