Add description for vTaskList (#206)
Describe each column which vTaskList print:
task name, task status, task priority, task stack unused watermark lewel, task number
Co-authored-by: David Chalco <59750547+dachalco@users.noreply.github.com>
diff --git a/include/task.h b/include/task.h
index d2d1a19..181ed70 100644
--- a/include/task.h
+++ b/include/task.h
@@ -1795,8 +1795,10 @@
* 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 and stack usage.
+ * uxTaskGetSystemState() output into a human readable table that displays task:
+ * names, states, priority, stack usage and task number.
+ * Stack usage specified as the number of unused StackType_t words stack can hold
+ * on top of stack - not the number of bytes.
*
* vTaskList() has a dependency on the sprintf() C library function that might
* bloat the code size, use a lot of stack, and provide different results on
diff --git a/tasks.c b/tasks.c
index 6ba21bb..a994ec9 100644
--- a/tasks.c
+++ b/tasks.c
@@ -4434,7 +4434,9 @@
*
* vTaskList() calls uxTaskGetSystemState(), then formats part of the
* uxTaskGetSystemState() output into a human readable table that
- * displays task names, states and stack usage.
+ * displays task: names, states, priority, stack usage and task number.
+ * Stack usage specified as the number of unused StackType_t words stack can hold
+ * on top of stack - not the number of bytes.
*
* vTaskList() has a dependency on the sprintf() C library function that
* might bloat the code size, use a lot of stack, and provide different
