gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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
59 changed files with 1828 additions and 1825 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
include/SDL3/SDL_version.h
View File

@@ -42,7 +42,7 @@ extern "C" {
*
* If this were SDL version 3.2.1, this value would be 3.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_MAJOR_VERSION 3
@@ -51,7 +51,7 @@ extern "C" {
*
* If this were SDL version 3.2.1, this value would be 2.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_MINOR_VERSION 1
@@ -60,7 +60,7 @@ extern "C" {
*
* If this were SDL version 3.2.1, this value would be 1.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_MICRO_VERSION 5
@@ -73,7 +73,7 @@ extern "C" {
* \param minor the minorversion number.
* \param patch the patch version number.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_VERSIONNUM(major, minor, patch) \
((major) * 1000000 + (minor) * 1000 + (patch))
@@ -85,7 +85,7 @@ extern "C" {
*
* \param version the version number.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_VERSIONNUM_MAJOR(version) ((version) / 1000000)
@@ -96,7 +96,7 @@ extern "C" {
*
* \param version the version number.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_VERSIONNUM_MINOR(version) (((version) / 1000) % 1000)
@@ -107,14 +107,14 @@ extern "C" {
*
* \param version the version number.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_VERSIONNUM_MICRO(version) ((version) % 1000)
/**
* This is the version number macro for the current SDL version.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_VERSION \
SDL_VERSIONNUM(SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_MICRO_VERSION)
@@ -122,7 +122,7 @@ extern "C" {
/**
* This macro will evaluate to true if compiled with SDL at least X.Y.Z.
*
* \since This macro is available since SDL 3.0.0.
* \since This macro is available since SDL 3.1.3.
*/
#define SDL_VERSION_ATLEAST(X, Y, Z) \
(SDL_VERSION >= SDL_VERSIONNUM(X, Y, Z))
@@ -139,7 +139,7 @@ extern "C" {
*
* \returns the version of the linked library.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetRevision
*/
@@ -165,7 +165,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetVersion(void);
* \returns an arbitrary string, uniquely identifying the exact revision of
* the SDL library in use.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_GetVersion
*/