fnsince: update \since policy for documentation.

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
59 changed files with 1828 additions and 1825 deletions

View File

@@ -43,7 +43,7 @@ extern "C" {
*
* If supported will display warning icon, etc.
*
* \since This datatype is available since SDL 3.0.0.
* \since This datatype is available since SDL 3.1.3.
*/
typedef Uint32 SDL_MessageBoxFlags;
@@ -56,7 +56,7 @@ typedef Uint32 SDL_MessageBoxFlags;
/**
* SDL_MessageBoxButtonData flags.
*
* \since This datatype is available since SDL 3.0.0.
* \since This datatype is available since SDL 3.1.3.
*/
typedef Uint32 SDL_MessageBoxButtonFlags;
@@ -66,7 +66,7 @@ typedef Uint32 SDL_MessageBoxButtonFlags;
/**
* Individual button data.
*
* \since This struct is available since SDL 3.0.0.
* \since This struct is available since SDL 3.1.3.
*/
typedef struct SDL_MessageBoxButtonData
{
@@ -78,7 +78,7 @@ typedef struct SDL_MessageBoxButtonData
/**
* RGB value used in a message box color scheme
*
* \since This struct is available since SDL 3.0.0.
* \since This struct is available since SDL 3.1.3.
*/
typedef struct SDL_MessageBoxColor
{
@@ -102,7 +102,7 @@ typedef enum SDL_MessageBoxColorType
/**
* A set of colors to use for message box dialogs
*
* \since This struct is available since SDL 3.0.0.
* \since This struct is available since SDL 3.1.3.
*/
typedef struct SDL_MessageBoxColorScheme
{
@@ -112,7 +112,7 @@ typedef struct SDL_MessageBoxColorScheme
/**
* MessageBox structure containing title, text, window, etc.
*
* \since This struct is available since SDL 3.0.0.
* \since This struct is available since SDL 3.1.3.
*/
typedef struct SDL_MessageBoxData
{
@@ -157,7 +157,7 @@ typedef struct SDL_MessageBoxData
* \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.
*
* \sa SDL_ShowSimpleMessageBox
*/
@@ -199,7 +199,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *me
* \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.
*
* \sa SDL_ShowMessageBox
*/