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.
2026-03-23 18:42:45 +08:00 · 2024-10-23 12:19:38 -04:00
parent 21c91d5535
commit 1c1706a00b
59 changed files with 1828 additions and 1825 deletions
--- a/include/SDL3/SDL_properties.h
+++ b/include/SDL3/SDL_properties.h
@@ -61,14 +61,14 @@ extern "C" {
 /**
 * SDL properties ID
 *
- * \since This datatype is available since SDL 3.0.0.
+ * \since This datatype is available since SDL 3.1.3.
 */
 typedef Uint32 SDL_PropertiesID;

 /**
 * SDL property type
 *
- * \since This enum is available since SDL 3.0.0.
+ * \since This enum is available since SDL 3.1.3.
 */
 typedef enum SDL_PropertyType
 {
@@ -86,7 +86,7 @@ typedef enum SDL_PropertyType
 * \returns a valid property ID on success or 0 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 SDL_PropertiesID SDLCALL SDL_GetGlobalProperties(void);

@@ -100,7 +100,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetGlobalProperties(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_DestroyProperties
 */
@@ -121,7 +121,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_CreateProperties(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.
 */
 extern SDL_DECLSPEC bool SDLCALL SDL_CopyProperties(SDL_PropertiesID src, SDL_PropertiesID dst);

@@ -143,7 +143,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CopyProperties(SDL_PropertiesID src, SDL_Pr
 *
 * \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_UnlockProperties
 */
@@ -156,7 +156,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockProperties(SDL_PropertiesID props);
 *
 * \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_LockProperties
 */
@@ -180,7 +180,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockProperties(SDL_PropertiesID props);
 * \threadsafety This callback may fire without any locks held; if this is a
 *               concern, the app should provide its own locking.
 *
- * \since This datatype is available since SDL 3.0.0.
+ * \since This datatype is available since SDL 3.1.3.
 *
 * \sa SDL_SetPointerPropertyWithCleanup
 */
@@ -209,7 +209,7 @@ typedef void (SDLCALL *SDL_CleanupPropertyCallback)(void *userdata, 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_GetPointerProperty
 * \sa SDL_SetPointerProperty
@@ -228,7 +228,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPointerPropertyWithCleanup(SDL_Propertie
 *
 * \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_GetPointerProperty
 * \sa SDL_HasProperty
@@ -254,7 +254,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetPointerProperty(SDL_PropertiesID props,
 *
 * \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_GetStringProperty
 */
@@ -271,7 +271,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetStringProperty(SDL_PropertiesID props, c
 *
 * \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_GetNumberProperty
 */
@@ -288,7 +288,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetNumberProperty(SDL_PropertiesID props, c
 *
 * \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_GetFloatProperty
 */
@@ -305,7 +305,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetFloatProperty(SDL_PropertiesID props, co
 *
 * \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_GetBooleanProperty
 */
@@ -320,7 +320,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetBooleanProperty(SDL_PropertiesID props,
 *
 * \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_GetPropertyType
 */
@@ -336,7 +336,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasProperty(SDL_PropertiesID props, const c
 *
 * \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_HasProperty
 */
@@ -363,7 +363,7 @@ extern SDL_DECLSPEC SDL_PropertyType SDLCALL SDL_GetPropertyType(SDL_PropertiesI
 *               If you need to avoid this, use SDL_LockProperties() and
 *               SDL_UnlockProperties().
 *
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
 *
 * \sa SDL_GetBooleanProperty
 * \sa SDL_GetFloatProperty
@@ -391,7 +391,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetPointerProperty(SDL_PropertiesID props
 *               If you need to avoid this, use SDL_LockProperties() and
 *               SDL_UnlockProperties().
 *
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
 *
 * \sa SDL_GetPropertyType
 * \sa SDL_HasProperty
@@ -413,7 +413,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetStringProperty(SDL_PropertiesID
 *
 * \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_GetPropertyType
 * \sa SDL_HasProperty
@@ -435,7 +435,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetNumberProperty(SDL_PropertiesID props,
 *
 * \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_GetPropertyType
 * \sa SDL_HasProperty
@@ -457,7 +457,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetFloatProperty(SDL_PropertiesID props, c
 *
 * \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_GetPropertyType
 * \sa SDL_HasProperty
@@ -475,7 +475,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetBooleanProperty(SDL_PropertiesID props,
 *
 * \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 bool SDLCALL SDL_ClearProperty(SDL_PropertiesID props, const char *name);

@@ -492,7 +492,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearProperty(SDL_PropertiesID props, const
 * \threadsafety SDL_EnumerateProperties holds a lock on `props` during this
 *               callback.
 *
- * \since This datatype is available since SDL 3.0.0.
+ * \since This datatype is available since SDL 3.1.3.
 *
 * \sa SDL_EnumerateProperties
 */
@@ -512,7 +512,7 @@ typedef void (SDLCALL *SDL_EnumeratePropertiesCallback)(void *userdata, SDL_Prop
 *
 * \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 bool SDLCALL SDL_EnumerateProperties(SDL_PropertiesID props, SDL_EnumeratePropertiesCallback callback, void *userdata);

@@ -528,7 +528,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_EnumerateProperties(SDL_PropertiesID props,
 *               locked or other threads might be setting or getting values
 *               from these properties.
 *
- * \since This function is available since SDL 3.0.0.
+ * \since This function is available since SDL 3.1.3.
 *
 * \sa SDL_CreateProperties
 */