eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-04 10:57:40 +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

42
include/SDL3/SDL_log.h
View file

@ -76,7 +76,7 @@ extern "C" {
* level, the assert category is enabled at the WARN level, test is enabled at
* the VERBOSE level and all other categories are enabled at the ERROR level.
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_LogCategory
{
@ -116,7 +116,7 @@ typedef enum SDL_LogCategory
/**
* The predefined log priorities
*
* \since This enum is available since SDL 3.0.0.
* \since This enum is available since SDL 3.1.3.
*/
typedef enum SDL_LogPriority
{
@ -139,7 +139,7 @@ typedef enum SDL_LogPriority
*
* \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_ResetLogPriorities
* \sa SDL_SetLogPriority
@ -154,7 +154,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetLogPriorities(SDL_LogPriority priority);
*
* \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_GetLogPriority
* \sa SDL_ResetLogPriorities
@ -170,7 +170,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetLogPriority(int category, SDL_LogPriorit
*
* \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_SetLogPriority
*/
@ -183,7 +183,7 @@ extern SDL_DECLSPEC SDL_LogPriority SDLCALL SDL_GetLogPriority(int category);
*
* \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_SetLogPriorities
* \sa SDL_SetLogPriority
@ -205,7 +205,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_ResetLogPriorities(void);
*
* \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_SetLogPriorities
* \sa SDL_SetLogPriority
@ -221,7 +221,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetLogPriorityPrefix(SDL_LogPriority priori
*
* \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_LogCritical
* \sa SDL_LogDebug
@ -245,7 +245,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Log(SDL_PRINTF_FORMAT_STRING const char *fm
*
* \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_Log
* \sa SDL_LogCritical
@ -270,7 +270,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogTrace(int category, SDL_PRINTF_FORMAT_ST
*
* \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_Log
* \sa SDL_LogCritical
@ -293,7 +293,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogVerbose(int category, SDL_PRINTF_FORMAT_
*
* \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_Log
* \sa SDL_LogCritical
@ -317,7 +317,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogDebug(int category, SDL_PRINTF_FORMAT_ST
*
* \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_Log
* \sa SDL_LogCritical
@ -341,7 +341,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogInfo(int category, SDL_PRINTF_FORMAT_STR
*
* \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_Log
* \sa SDL_LogCritical
@ -365,7 +365,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogWarn(int category, SDL_PRINTF_FORMAT_STR
*
* \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_Log
* \sa SDL_LogCritical
@ -389,7 +389,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogError(int category, SDL_PRINTF_FORMAT_ST
*
* \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_Log
* \sa SDL_LogDebug
@ -414,7 +414,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogCritical(int category, SDL_PRINTF_FORMAT
*
* \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_Log
* \sa SDL_LogCritical
@ -440,7 +440,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogMessage(int category,
*
* \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_Log
* \sa SDL_LogCritical
@ -469,7 +469,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LogMessageV(int category,
* \param priority the priority of the message.
* \param message the message being output.
*
* \since This datatype is available since SDL 3.0.0.
* \since This datatype is available since SDL 3.1.3.
*/
typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_LogPriority priority, const char *message);
@ -480,7 +480,7 @@ typedef void (SDLCALL *SDL_LogOutputFunction)(void *userdata, int category, SDL_
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.1.4.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_SetLogOutputFunction
* \sa SDL_GetLogOutputFunction
@ -497,7 +497,7 @@ extern SDL_DECLSPEC SDL_LogOutputFunction SDLCALL SDL_GetDefaultLogOutputFunctio
*
* \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_GetDefaultLogOutputFunction
* \sa SDL_SetLogOutputFunction
@ -512,7 +512,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetLogOutputFunction(SDL_LogOutputFunction
*
* \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_GetDefaultLogOutputFunction
* \sa SDL_GetLogOutputFunction