mirror of
https://github.com/espressif/esp-idf.git
synced 2025-08-15 14:36:45 +00:00
freertos(IDF): Sync cosmetic differences to v10.4.3
This commit synchronize the cosmetic differences of IDF FreeRTOS to upstream Vanilla v10.4.3. Comsetic differences include: - Out of date doxygen API descriptions - Misnamed parameters - Missing examples - Fixed/added missing @cond/@code directives - Extra/missing comments/lines - Code formatting (uncrustify) Other changes: - Some ESP_PLATFORM directives were also removed - xTaskIncrementTickOtherCores() now depends on "configNUM_CORES > 1" - Updated some multi-core dummy variable names in FreeRTOS.h
This commit is contained in:
@@ -147,9 +147,9 @@ typedef void (* PendedFunction_t)( void *,
|
||||
* which is "void vCallbackFunction( TimerHandle_t xTimer );".
|
||||
*
|
||||
* @return If the timer is successfully created then a handle to the newly
|
||||
* created timer is returned. If the timer cannot be created (because either
|
||||
* there is insufficient FreeRTOS heap remaining to allocate the timer
|
||||
* structures, or the timer period was set to 0) then NULL is returned.
|
||||
* created timer is returned. If the timer cannot be created because there is
|
||||
* insufficient FreeRTOS heap remaining to allocate the timer
|
||||
* structures then NULL is returned.
|
||||
*
|
||||
* Example usage:
|
||||
* @verbatim
|
||||
|
Reference in New Issue
Block a user