* 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
* 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
* 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