Review suggestions

Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>
This commit is contained in:
Gaurav Aggarwal 2024-01-25 08:24:48 +00:00
parent f669ae14ae
commit d20c95a441
12 changed files with 35 additions and 35 deletions

View file

@ -381,9 +381,9 @@
/*-----------------------------------------------------------*/
/*
* Reset state in this file. FreeRTOS initialises some of the internal variables
* at declaration time. This function is only required for application needs to
* restart the FreeRTOS scheduler.
* Reset state in this file. This state is normally initialized at start up.
* This function must be called by the application before restarting the
* scheduler.
*/
void vCoRoutineResetState( void )
{

View file

@ -748,8 +748,8 @@ BaseType_t xCoRoutineRemoveFromEventList( const List_t * pxEventList );
/*
* This function reset the internal state of coroutine by setting some of the internal
* variables to their default value.
* This function resets the internal state of the coroutine module. This
* function must be called by the application before restarting the scheduler.
*/
void vCoRoutineResetState( void ) PRIVILEGED_FUNCTION;

View file

@ -191,8 +191,8 @@ size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;
#endif
/*
* This function reset the internal state of heap by setting some of the internal
* variables to their default value.
* This function resets the internal state of the heap module. This function
* must be called by the application before restarting the scheduler.
*/
void vPortHeapResetState( void ) PRIVILEGED_FUNCTION;

View file

@ -3444,8 +3444,8 @@ BaseType_t xTaskCatchUpTicks( TickType_t xTicksToCatchUp ) PRIVILEGED_FUNCTION;
* void vTaskResetState( void );
* @endcode
*
* This function reset the internal state of task by setting some of the internal
* variables to their default value.
* This function resets the internal state of the task modeule. This function
* must be called by the application before restarting the scheduler.
*
* \defgroup vTaskResetState vTaskResetState
* \ingroup SchedulerControl

View file

@ -1418,8 +1418,8 @@ BaseType_t xTimerGenericCommandFromISR( TimerHandle_t xTimer,
#endif
/*
* This function reset the internal state of timer by setting some of the internal
* variables to their default value.
* This function resest the internal state of the timer module. This function
* must be called by the application before restarting the scheduler.
*/
void vTimerResetState( void ) PRIVILEGED_FUNCTION;

View file

@ -154,9 +154,9 @@ size_t xPortGetFreeHeapSize( void )
/*-----------------------------------------------------------*/
/*
* Reset the state in this file. FreeRTOS initialises some of the internal variables
* at declaration time. This function is only required for application needs to
* restart the FreeRTOS scheduler.
* Reset the state in this file. This state is normally initialized at start up.
* This function must be called by the application before restarting the
* scheduler.
*/
void vPortHeapResetState( void )
{

View file

@ -113,7 +113,7 @@ PRIVILEGED_DATA static BlockLink_t xStart, xEnd;
* fragmentation. */
PRIVILEGED_DATA static size_t xFreeBytesRemaining = configADJUSTED_HEAP_SIZE;
/* Indicate the heap has been initialised before or not. */
/* Indicates whether the heap has been initialised or not. */
PRIVILEGED_DATA static BaseType_t xHeapHasBeenInitialised = pdFALSE;
/*-----------------------------------------------------------*/
@ -388,9 +388,9 @@ static void prvHeapInit( void ) /* PRIVILEGED_FUNCTION */
/*-----------------------------------------------------------*/
/*
* Reset the state in this file. FreeRTOS initialises some of the internal variables
* at declaration time. This function is only required for application needs to
* restart the FreeRTOS scheduler.
* Reset the state in this file. This state is normally initialized at start up.
* This function must be called by the application before restarting the
* scheduler.
*/
void vPortHeapResetState( void )
{

View file

@ -95,12 +95,12 @@ void vPortFree( void * pv )
/*-----------------------------------------------------------*/
/*
* Reset the state in this file. FreeRTOS initialises some of the internal variables
* at declaration time. This function is only required for application needs to
* restart the FreeRTOS scheduler.
* Reset the state in this file. This state is normally initialized at start up.
* This function must be called by the application before restarting the
* scheduler.
*/
void vPortHeapResetState( void )
{
/* No internal variable is required to be re-initialised in heap_3. */
/* No state needs to be re-initialised in heap_3. */
}
/*-----------------------------------------------------------*/

View file

@ -610,9 +610,9 @@ void vPortGetHeapStats( HeapStats_t * pxHeapStats )
/*-----------------------------------------------------------*/
/*
* Reset the state in this file. FreeRTOS initialises some of the internal variables
* at declaration time. This function is only required for application needs to
* restart the FreeRTOS scheduler.
* Reset the state in this file. This state is normally initialized at start up.
* This function must be called by the application before restarting the
* scheduler.
*/
void vPortHeapResetState( void )
{

View file

@ -709,9 +709,9 @@ void vPortGetHeapStats( HeapStats_t * pxHeapStats )
/*-----------------------------------------------------------*/
/*
* Reset the state in this file. FreeRTOS initialises some of the internal variables
* at declaration time. This function is only required for application needs to
* restart the FreeRTOS scheduler.
* Reset the state in this file. This state is normally initialized at start up.
* This function must be called by the application before restarting the
* scheduler.
*/
void vPortHeapResetState( void )
{

View file

@ -8679,15 +8679,15 @@ static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,
/*-----------------------------------------------------------*/
/*
* Reset state in this file. FreeRTOS initialises some of the internal variables
* at declaration time. This function is only required for application needs to
* restart the FreeRTOS scheduler.
* Reset the state in this file. This state is normally initialized at start up.
* This function must be called by the application before restarting the
* scheduler.
*/
void vTaskResetState( void )
{
BaseType_t xCoreID;
/* * Task control block. */
/* Task control block. */
#if ( configNUMBER_OF_CORES == 1 )
{
pxCurrentTCB = NULL;

View file

@ -1323,9 +1323,9 @@
/*-----------------------------------------------------------*/
/*
* Reset state in this file. FreeRTOS initialises some of the internal variables
* at declaration time. This function is only required for application needs to
* restart the FreeRTOS scheduler.
* Reset the state in this file. This state is normally initialized at start up.
* This function must be called by the application before restarting the
* scheduler.
*/
void vTimerResetState( void )
{