eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-16 17:58:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

fnsince: update \since policy for documentation.

Browse source 
Everything in SDL3 up to the ABI lock is reported as available since 3.1.3.
Everything else will be reported as since 3.2.0 (what will be the first
official release).

Also ran a Perl script over the headers to change everything to 3.1.3 that
wasn't an API function, since fnsince.pl can't manage those. If there's a
macro or datatype that has snuck in that needs to be 3.2.0 instead, we'll
have to manually fix it up, but it shouldn't be a big deal in any case.

Reference PR #11304.
This commit is contained in:
Ryan C. Gordon 2024-10-23 12:19:38 -04:00
parent 21c91d5535
commit 1c1706a00b
No known key found for this signature in database
GPG key ID: FA148B892AB48044
59 changed files with 1828 additions and 1825 deletions
Download patch file Download diff file Expand all files Collapse all files

38
include/SDL3/SDL_thread.h
View file

@ -50,7 +50,7 @@ extern "C" {
*
* These are opaque data.
*
* \since This datatype is available since SDL 3.0.0.
* \since This datatype is available since SDL 3.1.3.
*
* \sa SDL_CreateThread
* \sa SDL_WaitThread
@ -64,7 +64,7 @@ typedef struct SDL_Thread SDL_Thread;
* application will operate on, but having a way to uniquely identify a thread
* can be useful at times.
*
* \since This datatype is available since SDL 3.0.0.
* \since This datatype is available since SDL 3.1.3.
*
* \sa SDL_GetThreadID
* \sa SDL_GetCurrentThreadID
@ -77,7 +77,7 @@ typedef Uint64 SDL_ThreadID;
* 0 is the invalid ID. An app can create these and then set data for these
* IDs that is unique to each thread.
*
* \since This datatype is available since SDL 3.0.0.
* \since This datatype is available since SDL 3.1.3.
*
* \sa SDL_GetTLS
* \sa SDL_SetTLS
@ -93,7 +93,7 @@ typedef SDL_AtomicInt SDL_TLSID;
* state. SDL_HINT_THREAD_PRIORITY_POLICY can be used to control aspects of
* this behavior.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_ThreadPriority {
SDL_THREAD_PRIORITY_LOW,
@ -108,7 +108,7 @@ typedef enum SDL_ThreadPriority {
* \param data what was passed as `data` to SDL_CreateThread().
* \returns a value that can be reported through SDL_WaitThread().
*
* \since This datatype is available since SDL 3.0.0.
* \since This datatype is available since SDL 3.1.3.
*/
typedef int (SDLCALL * SDL_ThreadFunction) (void *data);
@ -178,7 +178,7 @@ typedef int (SDLCALL * SDL_ThreadFunction) (void *data);
* new thread could not be created; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_CreateThreadWithProperties
* \sa SDL_WaitThread
@ -244,7 +244,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(SDL_ThreadFunction fn,
* new thread could not be created; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_CreateThread
* \sa SDL_WaitThread
@ -299,7 +299,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadWithProperties(SDL_Prop
* new thread could not be created; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadRuntime(SDL_ThreadFunction fn, const char *name, void *data, SDL_FunctionPointer pfnBeginThread, SDL_FunctionPointer pfnEndThread);
@ -313,7 +313,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadRuntime(SDL_ThreadFunct
* new thread could not be created; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadWithPropertiesRuntime(SDL_PropertiesID props, SDL_FunctionPointer pfnBeginThread, SDL_FunctionPointer pfnEndThread);
@ -333,7 +333,7 @@ extern SDL_DECLSPEC SDL_Thread * SDLCALL SDL_CreateThreadWithPropertiesRuntime(S
* \returns a pointer to a UTF-8 string that names the specified thread, or
* NULL if it doesn't have a name.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC const char * SDLCALL SDL_GetThreadName(SDL_Thread *thread);
@ -349,7 +349,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetThreadName(SDL_Thread *thread);
*
* \returns the ID of the current thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetThreadID
*/
@ -366,7 +366,7 @@ extern SDL_DECLSPEC SDL_ThreadID SDLCALL SDL_GetCurrentThreadID(void);
* \returns the ID of the specified thread, or the ID of the current thread if
* `thread` is NULL.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetCurrentThreadID
*/
@ -383,7 +383,7 @@ extern SDL_DECLSPEC SDL_ThreadID SDLCALL SDL_GetThreadID(SDL_Thread *thread);
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority priority);
@ -415,7 +415,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetCurrentThreadPriority(SDL_ThreadPriority
* from the thread function by its 'return', or NULL to not
* receive such value back.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_CreateThread
* \sa SDL_DetachThread
@ -451,7 +451,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status)
* \param thread the SDL_Thread pointer that was returned from the
* SDL_CreateThread() call that started this thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_CreateThread
* \sa SDL_WaitThread
@ -467,7 +467,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DetachThread(SDL_Thread *thread);
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_SetTLS
*/
@ -480,7 +480,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetTLS(SDL_TLSID *id);
*
* \param value a pointer previously handed to SDL_SetTLS.
*
* \since This datatype is available since SDL 3.0.0.
* \since This datatype is available since SDL 3.1.3.
*
* \sa SDL_SetTLS
*/
@ -508,7 +508,7 @@ typedef void (SDLCALL *SDL_TLSDestructorCallback)(void *value);
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetTLS
*/
@ -523,7 +523,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetTLS(SDL_TLSID *id, const void *value, SD
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC void SDLCALL SDL_CleanupTLS(void);