kernel: Fix k_thread_resource_pool_assign() documentation

The k_thread_resource_pool_assign() parameters were incorrectly
documented. Part of the thread parameter description should have been
in memory pool variable documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2020-05-01 12:37:51 +03:00 committed by Andrew Boie
commit fdf184858e

View file

@ -813,9 +813,9 @@ extern FUNC_NORETURN void k_thread_user_mode_enter(k_thread_entry_t entry,
* Changing a thread's resource pool will not migrate allocations from the * Changing a thread's resource pool will not migrate allocations from the
* previous pool. * previous pool.
* *
* @param thread Target thread to assign a memory pool for resource requests, * @param thread Target thread to assign a memory pool for resource requests.
* or NULL if the thread should no longer have a memory pool. * @param pool Memory pool to use for resources,
* @param pool Memory pool to use for resources. * or NULL if the thread should no longer have a memory pool.
*/ */
static inline void k_thread_resource_pool_assign(struct k_thread *thread, static inline void k_thread_resource_pool_assign(struct k_thread *thread,
struct k_mem_pool *pool) struct k_mem_pool *pool)