riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

core: expand documentation of thread_create()

Browse Source 
Adds specific documentation for the error return values of
thread_create().
This commit is contained in:
Martine Lenders 2015-02-13 16:47:19 +01:00 committed by Martine Lenders
parent 554d6dec4c
commit ffe9678bd1
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
core/include/thread.h
View File

@ -76,8 +76,10 @@
* @param[in] arg the argument to the function * @param[in] arg the argument to the function
* @param[in] name a human readable descriptor for the thread * @param[in] name a human readable descriptor for the thread
* *
* @return value ``<0`` on error * @return PID of newly created task on success
* @return pid of newly created task, otherwise * @return -EINVAL, if @p priority is greater than or equal to
* @ref SCHED_PRIO_LEVELS
* @return -EOVERFLOW, if there are too many threads running already
*/ */
kernel_pid_t thread_create(char *stack, kernel_pid_t thread_create(char *stack,
int stacksize, int stacksize,