Correct minor mistakes in code comments (#1371)
This commit revises some comments in the following files:
- event_groups.c
- include/queue.h
- include/task.h
Co-authored-by: Kody Stribrny <89810515+kstribrnAmzn@users.noreply.github.com>diff --git a/event_groups.c b/event_groups.c
index 1923bf7..7c5c15d 100644
--- a/event_groups.c
+++ b/event_groups.c
@@ -72,7 +72,7 @@
* The wait condition is defined by xWaitForAllBits. If xWaitForAllBits is
* pdTRUE then the wait condition is met if all the bits set in uxBitsToWaitFor
* are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the
- * wait condition is met if any of the bits set in uxBitsToWait for are also set
+ * wait condition is met if any of the bits set in uxBitsToWaitFor are also set
* in uxCurrentEventBits.
*/
static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits,
diff --git a/include/queue.h b/include/queue.h
index 4f74fd3..e3dbbef 100644
--- a/include/queue.h
+++ b/include/queue.h
@@ -202,8 +202,8 @@
* char ucData[ 20 ];
* };
*
- #define QUEUE_LENGTH 10
- #define ITEM_SIZE sizeof( uint32_t )
+ * #define QUEUE_LENGTH 10
+ * #define ITEM_SIZE sizeof( uint32_t )
*
* // xQueueBuffer will hold the queue structure.
* StaticQueue_t xQueueBuffer;
@@ -217,10 +217,10 @@
* QueueHandle_t xQueue1;
*
* // Create a queue capable of containing 10 uint32_t values.
- * xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold.
- * ITEM_SIZE // The size of each item in the queue
- * &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.
- * &xQueueBuffer ); // The buffer that will hold the queue structure.
+ * xQueue1 = xQueueCreateStatic( QUEUE_LENGTH, // The number of items the queue can hold.
+ * ITEM_SIZE, // The size of each item in the queue.
+ * &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.
+ * &xQueueBuffer ); // The buffer that will hold the queue structure.
*
* // The queue is guaranteed to be created successfully as no dynamic memory
* // allocation is used. Therefore xQueue1 is now a handle to a valid queue.
diff --git a/include/task.h b/include/task.h
index 72babea..2a19fa7 100644
--- a/include/task.h
+++ b/include/task.h
@@ -2617,9 +2617,8 @@
* notification value at that index being updated. ulValue is not used and
* xTaskNotifyIndexed() always returns pdPASS in this case.
*
- * pulPreviousNotificationValue -
- * Can be used to pass out the subject task's notification value before any
- * bits are modified by the notify function.
+ * @param pulPreviousNotificationValue Can be used to pass out the subject
+ * task's notification value before any bits are modified by the notify function.
*
* @return Dependent on the value of eAction. See the description of the
* eAction parameter.
@@ -2764,6 +2763,9 @@
* updated. ulValue is not used and xTaskNotify() always returns pdPASS in
* this case.
*
+ * @param pulPreviousNotificationValue Can be used to pass out the subject
+ * task's notification value before any bits are modified by the notify function.
+ *
* @param pxHigherPriorityTaskWoken xTaskNotifyFromISR() will set
* *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the
* task to which the notification was sent to leave the Blocked state, and the