Parcourir la source

Sync SDL3 wiki -> header

[ci skip]
SDL Wiki Bot il y a 2 semaines
Parent
commit
72ed7d0f87
3 fichiers modifiés avec 10 ajouts et 7 suppressions
  1. 2 1
      include/SDL3/SDL_main.h
  2. 4 2
      include/SDL3/SDL_mutex.h
  3. 4 4
      include/SDL3/SDL_thread.h

+ 2 - 1
include/SDL3/SDL_main.h

@@ -333,7 +333,8 @@ extern "C" {
  * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
  * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
  *          terminate with success, SDL_APP_CONTINUE to continue.
  *          terminate with success, SDL_APP_CONTINUE to continue.
  *
  *
- * \threadsafety This function is called once by SDL, at startup, on a single thread.
+ * \threadsafety This function is called once by SDL, at startup, on a single
+ *               thread.
  *
  *
  * \since This function is available since SDL 3.2.0.
  * \since This function is available since SDL 3.2.0.
  *
  *

+ 4 - 2
include/SDL3/SDL_mutex.h

@@ -380,7 +380,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockMutex(SDL_Mutex *mutex) SDL_TRY_ACQU
  *
  *
  * \param mutex the mutex to unlock.
  * \param mutex the mutex to unlock.
  *
  *
- * \threadsafety This call must be paired with a previous locking call on the same thread.
+ * \threadsafety This call must be paired with a previous locking call on the
+ *               same thread.
  *
  *
  * \since This function is available since SDL 3.2.0.
  * \since This function is available since SDL 3.2.0.
  *
  *
@@ -627,7 +628,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_TryLockRWLockForWriting(SDL_RWLock *rwlock)
  *
  *
  * \param rwlock the rwlock to unlock.
  * \param rwlock the rwlock to unlock.
  *
  *
- * \threadsafety This call must be paired with a previous locking call on the same thread.
+ * \threadsafety This call must be paired with a previous locking call on the
+ *               same thread.
  *
  *
  * \since This function is available since SDL 3.2.0.
  * \since This function is available since SDL 3.2.0.
  *
  *

+ 4 - 4
include/SDL3/SDL_thread.h

@@ -461,8 +461,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority
  *               function by its 'return', or -1 if the thread has been
  *               function by its 'return', or -1 if the thread has been
  *               detached or isn't valid, may be NULL.
  *               detached or isn't valid, may be NULL.
  *
  *
- * \threadsafety It is safe to call this function from any thread, but only
- *               a single thread can wait any specific thread to finish.
+ * \threadsafety It is safe to call this function from any thread, but only a
+ *               single thread can wait any specific thread to finish.
  *
  *
  * \since This function is available since SDL 3.2.0.
  * \since This function is available since SDL 3.2.0.
  *
  *
@@ -512,11 +512,11 @@ extern SDL_DECLSPEC SDL_ThreadState SDLCALL SDL_GetThreadState(SDL_Thread *threa
  *
  *
  * It is safe to pass NULL to this function; it is a no-op.
  * It is safe to pass NULL to this function; it is a no-op.
  *
  *
- * \threadsafety It is safe to call this function from any thread.
- *
  * \param thread the SDL_Thread pointer that was returned from the
  * \param thread the SDL_Thread pointer that was returned from the
  *               SDL_CreateThread() call that started this thread.
  *               SDL_CreateThread() call that started this thread.
  *
  *
+ * \threadsafety It is safe to call this function from any thread.
+ *
  * \since This function is available since SDL 3.2.0.
  * \since This function is available since SDL 3.2.0.
  *
  *
  * \sa SDL_CreateThread
  * \sa SDL_CreateThread