From 17df3fe8365c4913d2bb068ab6ca2d55d8100912 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Thu, 26 Dec 2024 18:26:48 +0000 Subject: [PATCH] Sync SDL3 wiki -> header [ci skip] --- include/SDL3/SDL_thread.h | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/include/SDL3/SDL_thread.h b/include/SDL3/SDL_thread.h index 7b7e6d5465..1821d15c62 100644 --- a/include/SDL3/SDL_thread.h +++ b/include/SDL3/SDL_thread.h @@ -407,15 +407,15 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority /** * Wait for a thread to finish. * - * Threads that haven't been detached will remain until this - * function cleans them up. Not doing so is a resource leak. + * Threads that haven't been detached will remain until this function cleans + * them up. Not doing so is a resource leak. * * Once a thread has been cleaned up through this function, the SDL_Thread * that references it becomes invalid and should not be referenced again. As * such, only one thread may call SDL_WaitThread() on another. * - * The return code from the thread function is placed in the area pointed to by - * `status`, if `status` is not NULL. + * The return code from the thread function is placed in the area pointed to + * by `status`, if `status` is not NULL. * * You may not wait on a thread that has been used in a call to * SDL_DetachThread(). Use either that function or this one, but not both, or @@ -428,8 +428,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority * * \param thread the SDL_Thread pointer that was returned from the * SDL_CreateThread() call that started this thread. - * \param status a pointer filled in with the value returned - * from the thread function by its 'return', or -1 if the thread has been detached or isn't valid, may be NULL. + * \param status a pointer filled in with the value returned from the thread + * function by its 'return', or -1 if the thread has been + * detached or isn't valid, may be NULL. * * \since This function is available since SDL 3.1.3. * @@ -442,7 +443,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status) * Get the current state of a thread. * * \param thread the thread to query. - * \returns the current state of a thread, or SDL_THREAD_UNKNOWN if the thread isn't valid. + * \returns the current state of a thread, or SDL_THREAD_UNKNOWN if the thread + * isn't valid. * * \since This function is available since SDL 3.2.0. *