alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/fix_tasK_create_static_doxygen_comment' into 'master'

Browse Source 
Fixed error in return type of xTaskCreateStatic

Closes IDFGH-2185

See merge request espressif/esp-idf!7253
This commit is contained in:
Angus Gratton 2020-01-10 11:41:15 +08:00
commit 4847c2adb0
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
components/freertos/include/freertos/task.h
View File

@ -481,9 +481,9 @@ is used in assert() statements. */
* cause the function to fail. * cause the function to fail.
* *
* @return If neither pxStackBuffer or pxTaskBuffer are NULL, then the task will * @return If neither pxStackBuffer or pxTaskBuffer are NULL, then the task will
* be created and pdPASS is returned. If either pxStackBuffer or pxTaskBuffer * be created and a task handle will be returned by which the created task
* are NULL then the task will not be created and * can be referenced. If either pxStackBuffer or pxTaskBuffer
* errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY is returned. * are NULL then the task will not be created and NULL is returned.
* *
* \ingroup Tasks * \ingroup Tasks
*/ */
@ -535,9 +535,9 @@ is used in assert() statements. */
* memory to be allocated dynamically. * memory to be allocated dynamically.
* *
* @return If neither pxStackBuffer or pxTaskBuffer are NULL, then the task will * @return If neither pxStackBuffer or pxTaskBuffer are NULL, then the task will
* be created and pdPASS is returned. If either pxStackBuffer or pxTaskBuffer * be created and a task handle will be returned by which the created task
* are NULL then the task will not be created and * can be referenced. If either pxStackBuffer or pxTaskBuffer
* errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY is returned. * are NULL then the task will not be created and NULL is returned.
* *
* @note If program uses thread local variables (ones specified with "__thread" keyword) * @note If program uses thread local variables (ones specified with "__thread" keyword)
* then storage for them will be allocated on the task's stack. * then storage for them will be allocated on the task's stack.