@@ -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 );
@@ -2195,28 +2196,29 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
21952196 UBaseType_t uxTaskGetSystemState ( TaskStatus_t * const pxTaskStatusArray ,
21962197 const UBaseType_t uxArraySize ,
21972198 configRUN_TIME_COUNTER_TYPE * const pulTotalRunTime ) PRIVILEGED_FUNCTION ;
2198- /**
2199- * For each task, call pxCallbackFunction with the task's handle and state,
2200- * and the provided context.
2201- *
2202- * NOTE: This function is intended for debugging use only as it suspends
2203- * the scheduler for an extended period. The callback runs while the
2204- * scheduler is suspended, so it must return quickly and must not perform
2205- * blocking operations.
2206- *
2207- * @param pxCallbackFunction Callback to invoke once for each task (passing
2208- * the task's handle, state, and the pvCallbackContext).
2209- *
2210- * @param pvCallbackContext Opaque caller-provided context passed through to
2211- * each callback invocation.
2212- *
2213- * @param pulTotalRunTime If configGENERATE_RUN_TIME_STATS is set to 1 in
2214- * FreeRTOSConfig.h then *pulTotalRunTime is set to the total run time since
2215- * boot. pulTotalRunTime can be set to NULL to omit the total run time
2216- * information.
2217- *
2218- * @return The number of TaskStatus_t snapshots provided to the callback.
2219- */
2199+
2200+ /**
2201+ * For each task, call pxCallbackFunction with the task's handle and state,
2202+ * and the provided context.
2203+ *
2204+ * NOTE: This function is intended for debugging use only as it suspends
2205+ * the scheduler for an extended period. The callback runs while the
2206+ * scheduler is suspended, so it must return quickly and must not perform
2207+ * blocking operations.
2208+ *
2209+ * @param pxCallbackFunction Callback to invoke once for each task (passing
2210+ * the task's handle, state, and the pvCallbackContext).
2211+ *
2212+ * @param pvCallbackContext Opaque caller-provided context passed through to
2213+ * each callback invocation.
2214+ *
2215+ * @param pulTotalRunTime If configGENERATE_RUN_TIME_STATS is set to 1 in
2216+ * FreeRTOSConfig.h then *pulTotalRunTime is set to the total run time since
2217+ * boot. pulTotalRunTime can be set to NULL to omit the total run time
2218+ * information.
2219+ *
2220+ * @return The number of TaskStatus_t snapshots provided to the callback.
2221+ */
22202222 UBaseType_t uxTaskCallForEachTask ( TaskStatusCallbackFunction_t pxCallbackFunction ,
22212223 void * pvCallbackContext ,
22222224 configRUN_TIME_COUNTER_TYPE * const pulTotalRunTime ) PRIVILEGED_FUNCTION ;
0 commit comments