Added more files to the Rowley and IAR LM3S demos to test building the newer files...

[freertos] / FreeRTOS / Source / include / task.h

diff --git a/FreeRTOS/Source/include/task.h b/FreeRTOS/Source/include/task.h
index b4d359cddf713292507d8ef22612f65da8671dd9..b54d21e3b1294ad058db2816dc9d040e2d7e8bd5 100644 (file)
--- a/FreeRTOS/Source/include/task.h
+++ b/FreeRTOS/Source/include/task.h
@@ -412,7 +412,7 @@ void vTaskAllocateMPURegions( xTaskHandle xTask, const xMemoryRegion * const pxR
 \r
 /**\r
  * task. h\r
- * <pre>void vTaskDelete( xTaskHandle pxTask );</pre>\r
+ * <pre>void vTaskDelete( xTaskHandle xTask );</pre>\r
  *\r
  * INCLUDE_vTaskDelete must be defined as 1 for this function to be available.\r
  * See the configuration section for more information.\r
@@ -430,7 +430,7 @@ void vTaskAllocateMPURegions( xTaskHandle xTask, const xMemoryRegion * const pxR
  * See the demo application file death.c for sample code that utilises\r
  * vTaskDelete ().\r
  *\r
- * @param pxTask The handle of the task to be deleted.  Passing NULL will\r
+ * @param xTask The handle of the task to be deleted.  Passing NULL will\r
  * cause the calling task to be deleted.\r
  *\r
  * Example usage:\r
@@ -449,7 +449,7 @@ void vTaskAllocateMPURegions( xTaskHandle xTask, const xMemoryRegion * const pxR
  * \defgroup vTaskDelete vTaskDelete\r
  * \ingroup Tasks\r
  */\r
-void vTaskDelete( xTaskHandle pxTaskToDelete ) PRIVILEGED_FUNCTION;\r
+void vTaskDelete( xTaskHandle xTaskToDelete ) PRIVILEGED_FUNCTION;\r
 \r
 /*-----------------------------------------------------------\r
  * TASK CONTROL API\r
@@ -566,17 +566,17 @@ void vTaskDelayUntil( portTickType * const pxPreviousWakeTime, portTickType xTim
 \r
 /**\r
  * task. h\r
- * <pre>unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask );</pre>\r
+ * <pre>unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle xTask );</pre>\r
  *\r
  * INCLUDE_xTaskPriorityGet must be defined as 1 for this function to be available.\r
  * See the configuration section for more information.\r
  *\r
  * Obtain the priority of any task.\r
  *\r
- * @param pxTask Handle of the task to be queried.  Passing a NULL\r
+ * @param xTask Handle of the task to be queried.  Passing a NULL\r
  * handle results in the priority of the calling task being returned.\r
  *\r
- * @return The priority of pxTask.\r
+ * @return The priority of xTask.\r
  *\r
  * Example usage:\r
    <pre>\r
@@ -609,11 +609,11 @@ void vTaskDelayUntil( portTickType * const pxPreviousWakeTime, portTickType xTim
  * \defgroup uxTaskPriorityGet uxTaskPriorityGet\r
  * \ingroup TaskCtrl\r
  */\r
-unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask ) PRIVILEGED_FUNCTION;\r
+unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle xTask ) PRIVILEGED_FUNCTION;\r
 \r
 /**\r
  * task. h\r
- * <pre>eTaskState eTaskGetState( xTaskHandle pxTask );</pre>\r
+ * <pre>eTaskState eTaskGetState( xTaskHandle xTask );</pre>\r
  *\r
  * INCLUDE_eTaskGetState must be defined as 1 for this function to be available.\r
  * See the configuration section for more information.\r
@@ -621,17 +621,17 @@ unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask ) PRIVILEGED_FUNCTI
  * Obtain the state of any task.  States are encoded by the eTaskState \r
  * enumerated type.\r
  *\r
- * @param pxTask Handle of the task to be queried.\r
+ * @param xTask Handle of the task to be queried.\r
  *\r
- * @return The state of pxTask at the time the function was called.  Note the\r
+ * @return The state of xTask at the time the function was called.  Note the\r
  * state of the task might change between the function being called, and the\r
  * functions return value being tested by the calling task.\r
  */\r
-eTaskState eTaskGetState( xTaskHandle pxTask ) PRIVILEGED_FUNCTION;\r
+eTaskState eTaskGetState( xTaskHandle xTask ) PRIVILEGED_FUNCTION;\r
 \r
 /**\r
  * task. h\r
- * <pre>void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority );</pre>\r
+ * <pre>void vTaskPrioritySet( xTaskHandle xTask, unsigned portBASE_TYPE uxNewPriority );</pre>\r
  *\r
  * INCLUDE_vTaskPrioritySet must be defined as 1 for this function to be available.\r
  * See the configuration section for more information.\r
@@ -641,7 +641,7 @@ eTaskState eTaskGetState( xTaskHandle pxTask ) PRIVILEGED_FUNCTION;
  * A context switch will occur before the function returns if the priority\r
  * being set is higher than the currently executing task.\r
  *\r
- * @param pxTask Handle to the task for which the priority is being set.\r
+ * @param xTask Handle to the task for which the priority is being set.\r
  * Passing a NULL handle results in the priority of the calling task being set.\r
  *\r
  * @param uxNewPriority The priority to which the task will be set.\r
@@ -669,11 +669,11 @@ eTaskState eTaskGetState( xTaskHandle pxTask ) PRIVILEGED_FUNCTION;
  * \defgroup vTaskPrioritySet vTaskPrioritySet\r
  * \ingroup TaskCtrl\r
  */\r
-void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority ) PRIVILEGED_FUNCTION;\r
+void vTaskPrioritySet( xTaskHandle xTask, unsigned portBASE_TYPE uxNewPriority ) PRIVILEGED_FUNCTION;\r
 \r
 /**\r
  * task. h\r
- * <pre>void vTaskSuspend( xTaskHandle pxTaskToSuspend );</pre>\r
+ * <pre>void vTaskSuspend( xTaskHandle xTaskToSuspend );</pre>\r
  *\r
  * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.\r
  * See the configuration section for more information.\r
@@ -685,7 +685,7 @@ void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority
  * i.e. calling vTaskSuspend () twice on the same task still only requires one\r
  * call to vTaskResume () to ready the suspended task.\r
  *\r
- * @param pxTaskToSuspend Handle to the task being suspended.  Passing a NULL\r
+ * @param xTaskToSuspend Handle to the task being suspended.  Passing a NULL\r
  * handle will cause the calling task to be suspended.\r
  *\r
  * Example usage:\r
@@ -720,11 +720,11 @@ void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority
  * \defgroup vTaskSuspend vTaskSuspend\r
  * \ingroup TaskCtrl\r
  */\r
-void vTaskSuspend( xTaskHandle pxTaskToSuspend ) PRIVILEGED_FUNCTION;\r
+void vTaskSuspend( xTaskHandle xTaskToSuspend ) PRIVILEGED_FUNCTION;\r
 \r
 /**\r
  * task. h\r
- * <pre>void vTaskResume( xTaskHandle pxTaskToResume );</pre>\r
+ * <pre>void vTaskResume( xTaskHandle xTaskToResume );</pre>\r
  *\r
  * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.\r
  * See the configuration section for more information.\r
@@ -735,7 +735,7 @@ void vTaskSuspend( xTaskHandle pxTaskToSuspend ) PRIVILEGED_FUNCTION;
  * will be made available for running again by a single call to\r
  * vTaskResume ().\r
  *\r
- * @param pxTaskToResume Handle to the task being readied.\r
+ * @param xTaskToResume Handle to the task being readied.\r
  *\r
  * Example usage:\r
    <pre>\r
@@ -769,11 +769,11 @@ void vTaskSuspend( xTaskHandle pxTaskToSuspend ) PRIVILEGED_FUNCTION;
  * \defgroup vTaskResume vTaskResume\r
  * \ingroup TaskCtrl\r
  */\r
-void vTaskResume( xTaskHandle pxTaskToResume ) PRIVILEGED_FUNCTION;\r
+void vTaskResume( xTaskHandle xTaskToResume ) PRIVILEGED_FUNCTION;\r
 \r
 /**\r
  * task. h\r
- * <pre>void xTaskResumeFromISR( xTaskHandle pxTaskToResume );</pre>\r
+ * <pre>void xTaskResumeFromISR( xTaskHandle xTaskToResume );</pre>\r
  *\r
  * INCLUDE_xTaskResumeFromISR must be defined as 1 for this function to be\r
  * available.  See the configuration section for more information.\r
@@ -784,12 +784,12 @@ void vTaskResume( xTaskHandle pxTaskToResume ) PRIVILEGED_FUNCTION;
  * will be made available for running again by a single call to\r
  * xTaskResumeFromISR ().\r
  *\r
- * @param pxTaskToResume Handle to the task being readied.\r
+ * @param xTaskToResume Handle to the task being readied.\r
  *\r
  * \defgroup vTaskResumeFromISR vTaskResumeFromISR\r
  * \ingroup TaskCtrl\r
  */\r
-portBASE_TYPE xTaskResumeFromISR( xTaskHandle pxTaskToResume ) PRIVILEGED_FUNCTION;\r
+portBASE_TYPE xTaskResumeFromISR( xTaskHandle xTaskToResume ) PRIVILEGED_FUNCTION;\r
 \r
 /*-----------------------------------------------------------\r
  * SCHEDULER CONTROL\r