Documentation bug in xTimerChangePeriodFromISR

Kernel
1

(Please let me know if this is not the right forum for documentation errors!)

The current documentation for xTimerChangePeriodFromISR appears to be missing the xNewPeriod argument in the code example presented there:

if( xTimerChangePeriodFromISR( xTimer, 
                               &xHigherPriorityTaskWoken ) != pdPASS )
    {
        /* The command to change the timers period was not executed
        successfully.  Take appropriate action here. */
    }

I believe that should read:

if( xTimerChangePeriodFromISR( xTimer, 
                               500 / portTICK_PERIOD_MS,
                               &xHigherPriorityTaskWoken ) != pdPASS )
    {
        /* The command to change the timers period was not executed
        successfully.  Take appropriate action here. */
    }
2

Thanks for taking the time to report this. It has been fixed although the fix won’t be visible until the website is deployed next.