From: richardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Date: Sun, 15 May 2011 17:31:53 +0000 (+0000)
Subject: Change some (xTIMER *) references in the documentation for the timer module to be... 
X-Git-Tag: V7.0.2~184
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=5ec0df2a1427d30905b20ad4514a5a2e3d4891b0;p=freertos

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).

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@1426 1d2547de-c912-0410-9cb9-b8ca96c0e9e2
---

diff --git a/Source/include/timers.h b/Source/include/timers.h
index 3d78c0ae0..3faef90d8 100644
--- a/Source/include/timers.h
+++ b/Source/include/timers.h
@@ -134,7 +134,7 @@ typedef void (*tmrTIMER_CALLBACK)( xTimerHandle xTimer );
  *
  * @param pxCallbackFunction The function to call when the timer expires.
  * 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
  * 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
  * // associated timer expires, and stop the timer once the timer has expired
  * // 10 times.
- * void vTimerCallback( xTIMER *pxTimer )
+ * void vTimerCallback( xTimerHandle pxTimer )
  * {
  * long lArrayIndex;
  * 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
  * // parameter is not used.
- * void vBacklightTimerCallback( xTIMER *pxTimer )
+ * void vBacklightTimerCallback( xTimerHandle pxTimer )
  * {
  *     // The timer expired, therefore 5 seconds must have passed since a key
  *     // 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
  * // parameter is not used.
- * void vBacklightTimerCallback( xTIMER *pxTimer )
+ * void vBacklightTimerCallback( xTimerHandle pxTimer )
  * {
  *     // The timer expired, therefore 5 seconds must have passed since a key
  *     // 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
  * // parameter is not used.
- * void vBacklightTimerCallback( xTIMER *pxTimer )
+ * void vBacklightTimerCallback( xTimerHandle pxTimer )
  * {
  *     // The timer expired, therefore 5 seconds must have passed since a key
  *     // was pressed.  Switch off the LCD back-light.