Ensure both one-shot and auto-reload are written consistently with a hyphen in comments.

This commit is contained in:
Richard Barry 2020-01-16 04:25:29 +00:00
parent 9456992c1f
commit 42a0eaafdc
20 changed files with 104 additions and 83 deletions

View file

@ -173,7 +173,7 @@ static void prvPermanentlyBlockingNotificationTask( void *pvParameters );
/*
* The test function and callback function used when exercising the timer AP
* function that changes the timer's autoreload mode.
* function that changes the timer's auto-reload mode.
*/
static void prvDemonstrateChangingTimerReloadMode( void *pvParameters );
static void prvReloadModeTestTimerCallback( TimerHandle_t xTimer );
@ -866,7 +866,7 @@ const TickType_t x100ms = pdMS_TO_TICKS( 100UL );
xTimer = xTimerCreate( pcTimerName,
x100ms,
pdFALSE, /* Created as a one shot timer. */
pdFALSE, /* Created as a one-shot timer. */
0,
prvReloadModeTestTimerCallback );
configASSERT( xTimer );
@ -875,7 +875,7 @@ const TickType_t x100ms = pdMS_TO_TICKS( 100UL );
configASSERT( strcmp( pcTimerName, pcTimerGetName( xTimer ) ) == 0 );
configASSERT( xTimerGetPeriod( xTimer ) == x100ms );
/* Timer was created as a one shot timer. Its callback just increments the
/* Timer was created as a one-shot timer. Its callback just increments the
timer's ID - so set the ID to 0, let the timer run for a number of timeout
periods, then check the timer has only executed once. */
vTimerSetTimerID( xTimer, ( void * ) 0 );
@ -883,7 +883,7 @@ const TickType_t x100ms = pdMS_TO_TICKS( 100UL );
vTaskDelay( 3UL * x100ms );
configASSERT( ( ( uint32_t ) ( pvTimerGetTimerID( xTimer ) ) ) == 1UL );
/* Now change the timer to be an autoreload timer and check it executes
/* Now change the timer to be an auto-reload timer and check it executes
the expected number of times. */
vTimerSetReloadMode( xTimer, pdTRUE );
vTimerSetTimerID( xTimer, ( void * ) 0 );
@ -892,7 +892,7 @@ const TickType_t x100ms = pdMS_TO_TICKS( 100UL );
configASSERT( ( uint32_t ) ( pvTimerGetTimerID( xTimer ) ) == 3UL );
configASSERT( xTimerStop( xTimer, 0 ) != pdFAIL );
/* Now change the timer back to be a one shot timer and check it only
/* Now change the timer back to be a one-shot timer and check it only
executes once. */
vTimerSetReloadMode( xTimer, pdFALSE );
vTimerSetTimerID( xTimer, ( void * ) 0 );