From ffe9678bd16b3301fab3c62824f7f719902530a3 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Fri, 13 Feb 2015 16:47:19 +0100 Subject: [PATCH] core: expand documentation of thread_create() Adds specific documentation for the error return values of thread_create(). --- core/include/thread.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/core/include/thread.h b/core/include/thread.h index 18f9006efe..95d150596f 100644 --- a/core/include/thread.h +++ b/core/include/thread.h @@ -76,8 +76,10 @@ * @param[in] arg the argument to the function * @param[in] name a human readable descriptor for the thread * - * @return value ``<0`` on error - * @return pid of newly created task, otherwise + * @return PID of newly created task on success + * @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, int stacksize,