From ac71831350cd97bd4b240d6fbf5daf37c9e720a2 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Thu, 12 Oct 2023 15:20:53 -0400
Subject: [PATCH] Sync wiki -> headers
---
include/SDL3/SDL_audio.h | 3 ++-
include/SDL3/SDL_gamepad.h | 3 ++-
include/SDL3/SDL_joystick.h | 3 ++-
include/SDL3/SDL_properties.h | 22 +++++++++++++---------
include/SDL3/SDL_render.h | 6 ++++--
include/SDL3/SDL_rwops.h | 3 ++-
include/SDL3/SDL_sensor.h | 3 ++-
include/SDL3/SDL_surface.h | 3 ++-
include/SDL3/SDL_video.h | 3 ++-
9 files changed, 31 insertions(+), 18 deletions(-)
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index 481bfc599a38..952d958a4fdb 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -680,7 +680,8 @@ extern DECLSPEC SDL_AudioStream *SDLCALL SDL_CreateAudioStream(const SDL_AudioSp
* Get the properties associated with an audio stream.
*
* \param stream the SDL_AudioStream to query
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*
diff --git a/include/SDL3/SDL_gamepad.h b/include/SDL3/SDL_gamepad.h
index bb950272f37b..5f409432d968 100644
--- a/include/SDL3/SDL_gamepad.h
+++ b/include/SDL3/SDL_gamepad.h
@@ -562,7 +562,8 @@ extern DECLSPEC SDL_Gamepad *SDLCALL SDL_GetGamepadFromPlayerIndex(int player_in
*
* \param gamepad a gamepad identifier previously returned by
* SDL_OpenGamepad()
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*
diff --git a/include/SDL3/SDL_joystick.h b/include/SDL3/SDL_joystick.h
index e3c9a9f8cf94..7b73537f6414 100644
--- a/include/SDL3/SDL_joystick.h
+++ b/include/SDL3/SDL_joystick.h
@@ -461,7 +461,8 @@ extern DECLSPEC int SDLCALL SDL_SetJoystickVirtualHat(SDL_Joystick *joystick, in
* Get the properties associated with a joystick.
*
* \param joystick the SDL_Joystick obtained from SDL_OpenJoystick()
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*
diff --git a/include/SDL3/SDL_properties.h b/include/SDL3/SDL_properties.h
index efa700ee9e98..4c1335fb737f 100644
--- a/include/SDL3/SDL_properties.h
+++ b/include/SDL3/SDL_properties.h
@@ -42,7 +42,8 @@ typedef Uint32 SDL_PropertiesID;
/**
* Create a set of properties
*
- * \returns an ID for a new set of properties, or 0 on failure; call SDL_GetError() for more information.
+ * \returns an ID for a new set of properties, or 0 on failure; call
+ * SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
*
@@ -53,12 +54,16 @@ extern DECLSPEC SDL_PropertiesID SDLCALL SDL_CreateProperties(void);
/**
* Lock a set of properties
*
- * Obtain a multi-threaded lock for these properties. Other threads will wait while trying to lock these properties until they are unlocked. Properties must be unlocked before they are destroyed.
+ * Obtain a multi-threaded lock for these properties. Other threads will wait
+ * while trying to lock these properties until they are unlocked. Properties
+ * must be unlocked before they are destroyed.
*
- * The lock is automatically taken when setting individual properties, this function is only needed when you want to set several properties atomically or want to guarantee that properties being queried aren't freed in another thread.
+ * The lock is automatically taken when setting individual properties, this
+ * function is only needed when you want to set several properties atomically
+ * or want to guarantee that properties being queried aren't freed in another
+ * thread.
*
* \param props the properties to lock
- *
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
@@ -85,9 +90,9 @@ extern DECLSPEC void SDLCALL SDL_UnlockProperties(SDL_PropertiesID props);
* \param props the properties to modify
* \param name the name of the property to modify
* \param value the new value of the property, or NULL to delete the property
- * \param cleanup the function to call when this property is deleted, or NULL if no cleanup is necessary
+ * \param cleanup the function to call when this property is deleted, or NULL
+ * if no cleanup is necessary
* \param userdata a pointer that is passed to the cleanup function
- *
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
@@ -102,7 +107,6 @@ extern DECLSPEC int SDLCALL SDL_SetProperty(SDL_PropertiesID props, const char *
*
* \param props the properties to query
* \param name the name of the property to query
- *
* \returns the value of the property, or NULL if it is not set.
*
* \since This function is available since SDL 3.0.0.
@@ -116,7 +120,6 @@ extern DECLSPEC void *SDLCALL SDL_GetProperty(SDL_PropertiesID props, const char
*
* \param props the properties to modify
* \param name the name of the property to clear
- *
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*
@@ -129,7 +132,8 @@ extern DECLSPEC int SDLCALL SDL_ClearProperty(SDL_PropertiesID props, const char
/**
* Destroy a set of properties
*
- * All properties are deleted and their cleanup functions will be called, if any. The set of properties must be unlocked when it is destroyed.
+ * All properties are deleted and their cleanup functions will be called, if
+ * any. The set of properties must be unlocked when it is destroyed.
*
* \param props the properties to destroy
*
diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h
index ae08703697cf..57f85fd3d612 100644
--- a/include/SDL3/SDL_render.h
+++ b/include/SDL3/SDL_render.h
@@ -320,7 +320,8 @@ extern DECLSPEC int SDLCALL SDL_GetRendererInfo(SDL_Renderer *renderer, SDL_Rend
* Get the properties associated with a renderer.
*
* \param renderer the rendering context
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*
@@ -440,7 +441,8 @@ extern DECLSPEC IDXGIResource* SDLCALL SDL_GetTextureDXGIResource(SDL_Texture *t
* Get the properties associated with a texture.
*
* \param texture the texture to query
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*
diff --git a/include/SDL3/SDL_rwops.h b/include/SDL3/SDL_rwops.h
index 74c1ec6ec187..26fd5299f471 100644
--- a/include/SDL3/SDL_rwops.h
+++ b/include/SDL3/SDL_rwops.h
@@ -337,7 +337,8 @@ extern DECLSPEC void SDLCALL SDL_DestroyRW(SDL_RWops *context);
* Get the properties associated with an SDL_RWops.
*
* \param context a pointer to an SDL_RWops structure
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*
diff --git a/include/SDL3/SDL_sensor.h b/include/SDL3/SDL_sensor.h
index 4829bea472e9..3c99f6825435 100644
--- a/include/SDL3/SDL_sensor.h
+++ b/include/SDL3/SDL_sensor.h
@@ -194,7 +194,8 @@ extern DECLSPEC SDL_Sensor *SDLCALL SDL_GetSensorFromInstanceID(SDL_SensorID ins
* Get the properties associated with a sensor.
*
* \param sensor The SDL_Sensor object
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*
diff --git a/include/SDL3/SDL_surface.h b/include/SDL3/SDL_surface.h
index 4a782175d564..0cbf1eb9755b 100644
--- a/include/SDL3/SDL_surface.h
+++ b/include/SDL3/SDL_surface.h
@@ -194,7 +194,8 @@ extern DECLSPEC void SDLCALL SDL_DestroySurface(SDL_Surface *surface);
* Get the properties associated with a surface.
*
* \param surface the SDL_Surface structure to query
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*
diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h
index c3958e37492d..76b78ec9487f 100644
--- a/include/SDL3/SDL_video.h
+++ b/include/SDL3/SDL_video.h
@@ -921,7 +921,8 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_GetWindowParent(SDL_Window *window);
* Get the properties associated with a window.
*
* \param window the window to query
- * \returns a valid property ID on success or 0 on failure; call SDL_GetError() for more information.
+ * \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.
*