@@ -185,9 +185,10 @@ typedef struct xTASK_STATUS
185185} TaskStatus_t ;
186186
187187#if ( configUSE_TRACE_FACILITY == 1 )
188- /* Callback type used by uxTaskCallForEachTask(). The callback receives one
189- * task handle and state at a time, plus an opaque caller-supplied context
190- * pointer. The callback may call vTaskGetInfo() if it needs a TaskStatus_t. */
188+
189+ /* Callback type used by uxTaskCallForEachTask(). The callback receives one
190+ * task handle and state at a time, plus an opaque caller-supplied context
191+ * pointer. The callback may call vTaskGetInfo() if it needs a TaskStatus_t. */
191192 typedef void (* TaskStatusCallbackFunction_t )( TaskHandle_t xTask ,
192193 eTaskState eState ,
193194 void * pvCallbackContext );
@@ -2219,28 +2220,29 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
22192220 UBaseType_t uxTaskGetSystemState ( TaskStatus_t * const pxTaskStatusArray ,
22202221 const UBaseType_t uxArraySize ,
22212222 configRUN_TIME_COUNTER_TYPE * const pulTotalRunTime ) PRIVILEGED_FUNCTION ;
2222- /**
2223- * For each task, call pxCallbackFunction with the task's handle and state,
2224- * and the provided context.
2225- *
2226- * NOTE: This function is intended for debugging use only as it suspends
2227- * the scheduler for an extended period. The callback runs while the
2228- * scheduler is suspended, so it must return quickly and must not perform
2229- * blocking operations.
2230- *
2231- * @param pxCallbackFunction Callback to invoke once for each task (passing
2232- * the task's handle, state, and the pvCallbackContext).
2233- *
2234- * @param pvCallbackContext Opaque caller-provided context passed through to
2235- * each callback invocation.
2236- *
2237- * @param pulTotalRunTime If configGENERATE_RUN_TIME_STATS is set to 1 in
2238- * FreeRTOSConfig.h then *pulTotalRunTime is set to the total run time since
2239- * boot. pulTotalRunTime can be set to NULL to omit the total run time
2240- * information.
2241- *
2242- * @return The number of TaskStatus_t snapshots provided to the callback.
2243- */
2223+
2224+ /**
2225+ * For each task, call pxCallbackFunction with the task's handle and state,
2226+ * and the provided context.
2227+ *
2228+ * NOTE: This function is intended for debugging use only as it suspends
2229+ * the scheduler for an extended period. The callback runs while the
2230+ * scheduler is suspended, so it must return quickly and must not perform
2231+ * blocking operations.
2232+ *
2233+ * @param pxCallbackFunction Callback to invoke once for each task (passing
2234+ * the task's handle, state, and the pvCallbackContext).
2235+ *
2236+ * @param pvCallbackContext Opaque caller-provided context passed through to
2237+ * each callback invocation.
2238+ *
2239+ * @param pulTotalRunTime If configGENERATE_RUN_TIME_STATS is set to 1 in
2240+ * FreeRTOSConfig.h then *pulTotalRunTime is set to the total run time since
2241+ * boot. pulTotalRunTime can be set to NULL to omit the total run time
2242+ * information.
2243+ *
2244+ * @return The number of TaskStatus_t snapshots provided to the callback.
2245+ */
22442246 UBaseType_t uxTaskCallForEachTask ( TaskStatusCallbackFunction_t pxCallbackFunction ,
22452247 void * pvCallbackContext ,
22462248 configRUN_TIME_COUNTER_TYPE * const pulTotalRunTime ) PRIVILEGED_FUNCTION ;
0 commit comments