Add an example of human readable table generated by vTaskListTasks() to tash.h (#1215)
* Add an example of human readable table generated by vTaskListTasks() to task.h
diff --git a/include/task.h b/include/task.h
index 0414eb9..a25740e 100644
--- a/include/task.h
+++ b/include/task.h
@@ -2199,8 +2199,8 @@
* Lists all the current tasks, along with their current state and stack
* usage high water mark.
*
- * Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or
- * suspended ('S').
+ * Tasks are reported as running ('X'), blocked ('B'), ready ('R'), deleted ('D')
+ * or suspended ('S').
*
* PLEASE NOTE:
*
@@ -2208,8 +2208,16 @@
* demo applications. Do not consider it to be part of the scheduler.
*
* vTaskListTasks() calls uxTaskGetSystemState(), then formats part of the
- * uxTaskGetSystemState() output into a human readable table that displays task:
- * names, states, priority, stack usage and task number.
+ * uxTaskGetSystemState() output into a human readable table that displays task
+ * information in the following format:
+ * Task Name, Task State, Task Priority, Task Stack High Watermak, Task Number.
+ *
+ * The following is a sample output:
+ * Task A X 2 67 2
+ * Task B R 1 67 3
+ * IDLE R 0 67 5
+ * Tmr Svc B 6 137 6
+ *
* Stack usage specified as the number of unused StackType_t words stack can hold
* on top of stack - not the number of bytes.
*
@@ -2260,8 +2268,8 @@
* Lists all the current tasks, along with their current state and stack
* usage high water mark.
*
- * Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or
- * suspended ('S').
+ * Tasks are reported as running ('X'), blocked ('B'), ready ('R'), deleted ('D')
+ * or suspended ('S').
*
* PLEASE NOTE:
*
@@ -2269,8 +2277,16 @@
* demo applications. Do not consider it to be part of the scheduler.
*
* vTaskList() calls uxTaskGetSystemState(), then formats part of the
- * uxTaskGetSystemState() output into a human readable table that displays task:
- * names, states, priority, stack usage and task number.
+ * uxTaskGetSystemState() output into a human readable table that displays task
+ * information in the following format:
+ * Task Name, Task State, Task Priority, Task Stack High Watermak, Task Number.
+ *
+ * The following is a sample output:
+ * Task A X 2 67 2
+ * Task B R 1 67 3
+ * IDLE R 0 67 5
+ * Tmr Svc B 6 137 6
+ *
* Stack usage specified as the number of unused StackType_t words stack can hold
* on top of stack - not the number of bytes.
*
