Add an example of human readable table generated by vTaskListTasks() to task.h

This commit is contained in:
Rick 2024-12-24 17:48:13 +08:00
parent f31787d35d
commit 79a66c6df1

View file

@ -2199,9 +2199,16 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
* 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
* Tasks are reported as running ('X'), blocked ('B'), ready ('R'), deleted ('D') or
* suspended ('S').
*
* The example of a human readable table generated by vTaskListTasks()
* Task Name State Priority HighWaterMark Task ID
* Task A X 2 67 2
* Task B R 1 67 3
* IDLE R 0 67 5
* Tmr Svc B 6 137 6
*
* PLEASE NOTE:
*
* This function is provided for convenience only, and is used by many of the