len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-08-29 22:48:37 -04:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

4
FreeRTOS/Source/include/timers.h
View file

@ -1235,7 +1235,7 @@ const char * pcTimerGetName( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION; /*lint
* void vTimerSetReloadMode( TimerHandle_t xTimer, const UBaseType_t uxAutoReload );
*
* Updates a timer to be either an auto-reload timer, in which case the timer
* automatically resets itself each time it expires, or a one shot timer, in
* automatically resets itself each time it expires, or a one-shot timer, in
* which case the timer will only expire once unless it is manually restarted.
*
* @param xTimer The handle of the timer being updated.
@ -1252,7 +1252,7 @@ void vTimerSetReloadMode( TimerHandle_t xTimer, const UBaseType_t uxAutoReload )
* UBaseType_t uxTimerGetReloadMode( TimerHandle_t xTimer );
*
* Queries a timer to determine if it is an auto-reload timer, in which case the timer
* automatically resets itself each time it expires, or a one shot timer, in
* automatically resets itself each time it expires, or a one-shot timer, in
* which case the timer will only expire once unless it is manually restarted.
*
* @param xTimer The handle of the timer being queried.