commit 9f316c246baafa15c542a5aea81a94f26e3d6507

[freertos] / FreeRTOS / Source / include / timers.h

diff --git a/FreeRTOS/Source/include/timers.h b/FreeRTOS/Source/include/timers.h
index 91483846792ed3e93f795e5cb7628ba6379d1393..205ad62fcb4afddab6afe3ac0fe7559b61a8d0dc 100644 (file)
--- a/FreeRTOS/Source/include/timers.h
+++ b/FreeRTOS/Source/include/timers.h
@@ -121,7 +121,7 @@ typedef void (*PendedFunction_t)( void *, uint32_t );
  * after 100 ticks, then xTimerPeriodInTicks should be set to 100.\r
  * Alternatively, if the timer must expire after 500ms, then xPeriod can be set\r
  * to ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than or\r
- * equal to 1000.\r
+ * equal to 1000.  Time timer period must be greater than 0.\r
  *\r
  * @param uxAutoReload If uxAutoReload is set to pdTRUE then the timer will\r
  * expire repeatedly with a frequency set by the xTimerPeriodInTicks parameter.\r
@@ -138,9 +138,9 @@ typedef void (*PendedFunction_t)( void *, uint32_t );
  * which is    "void vCallbackFunction( TimerHandle_t xTimer );".\r
  *\r
  * @return If the timer is successfully created then a handle to the newly\r
- * created timer is returned.  If the timer cannot be created (because either\r
- * there is insufficient FreeRTOS heap remaining to allocate the timer\r
- * structures, or the timer period was set to 0) then NULL is returned.\r
+ * created timer is returned.  If the timer cannot be created because there is\r
+ * insufficient FreeRTOS heap remaining to allocate the timer\r
+ * structures then NULL is returned.\r
  *\r
  * Example usage:\r
  * @verbatim\r
@@ -267,7 +267,7 @@ typedef void (*PendedFunction_t)( void *, uint32_t );
  * after 100 ticks, then xTimerPeriodInTicks should be set to 100.\r
  * Alternatively, if the timer must expire after 500ms, then xPeriod can be set\r
  * to ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than or\r
- * equal to 1000.\r
+ * equal to 1000.  The timer period must be greater than 0.\r
  *\r
  * @param uxAutoReload If uxAutoReload is set to pdTRUE then the timer will\r
  * expire repeatedly with a frequency set by the xTimerPeriodInTicks parameter.\r