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

Change some (xTIMER *) references in the documentation for the timer module to be instead xTimerHandle references (the two are in effect equivalent, but xTIMER is private to the timers source file).

Browse source
This commit is contained in:
Richard Barry 2011-05-15 17:31:53 +00:00
parent f5a6b610e1
commit dedc9d8c46
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Source/include/timers.h
View file

@ -134,7 +134,7 @@ typedef void (*tmrTIMER_CALLBACK)( xTimerHandle xTimer );
* *
* @param pxCallbackFunction The function to call when the timer expires. * @param pxCallbackFunction The function to call when the timer expires.
* Callback functions must have the prototype defined by tmrTIMER_CALLBACK, * Callback functions must have the prototype defined by tmrTIMER_CALLBACK,
* which is "void vCallbackFunction( xTIMER *xTimer );". * which is "void vCallbackFunction( xTimerHandle xTimer );".
* *
* @return If the timer is successfully create then a handle to the newly * @return If the timer is successfully create then a handle to the newly
* created timer is returned. If the timer cannot be created (because either * created timer is returned. If the timer cannot be created (because either
@ -156,7 +156,7 @@ typedef void (*tmrTIMER_CALLBACK)( xTimerHandle xTimer );
* // The callback function does nothing but count the number of times the * // The callback function does nothing but count the number of times the
* // associated timer expires, and stop the timer once the timer has expired * // associated timer expires, and stop the timer once the timer has expired
* // 10 times. * // 10 times.
* void vTimerCallback( xTIMER *pxTimer ) * void vTimerCallback( xTimerHandle pxTimer )
* { * {
* long lArrayIndex; * long lArrayIndex;
* const long xMaxExpiryCountBeforeStopping = 10; * const long xMaxExpiryCountBeforeStopping = 10;
@ -551,7 +551,7 @@ portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;
* *
* // The callback function assigned to the one-shot timer. In this case the * // The callback function assigned to the one-shot timer. In this case the
* // parameter is not used. * // parameter is not used.
* void vBacklightTimerCallback( xTIMER *pxTimer ) * void vBacklightTimerCallback( xTimerHandle pxTimer )
* { * {
* // The timer expired, therefore 5 seconds must have passed since a key * // The timer expired, therefore 5 seconds must have passed since a key
* // was pressed. Switch off the LCD back-light. * // was pressed. Switch off the LCD back-light.
@ -657,7 +657,7 @@ portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;
* *
* // The callback function assigned to the one-shot timer. In this case the * // The callback function assigned to the one-shot timer. In this case the
* // parameter is not used. * // parameter is not used.
* void vBacklightTimerCallback( xTIMER *pxTimer ) * void vBacklightTimerCallback( xTimerHandle pxTimer )
* { * {
* // The timer expired, therefore 5 seconds must have passed since a key * // The timer expired, therefore 5 seconds must have passed since a key
* // was pressed. Switch off the LCD back-light. * // was pressed. Switch off the LCD back-light.
@ -876,7 +876,7 @@ portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;
* *
* // The callback function assigned to the one-shot timer. In this case the * // The callback function assigned to the one-shot timer. In this case the
* // parameter is not used. * // parameter is not used.
* void vBacklightTimerCallback( xTIMER *pxTimer ) * void vBacklightTimerCallback( xTimerHandle pxTimer )
* { * {
* // The timer expired, therefore 5 seconds must have passed since a key * // The timer expired, therefore 5 seconds must have passed since a key
* // was pressed. Switch off the LCD back-light. * // was pressed. Switch off the LCD back-light.