]> git.sur5r.net Git - freertos/commitdiff
Change some (xTIMER *) references in the documentation for the timer module to be...
authorrichardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Sun, 15 May 2011 17:31:53 +0000 (17:31 +0000)
committerrichardbarry <richardbarry@1d2547de-c912-0410-9cb9-b8ca96c0e9e2>
Sun, 15 May 2011 17:31:53 +0000 (17:31 +0000)
git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@1426 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

Source/include/timers.h

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