SDL: Updated headers with latest wikiheaders tweaks.

From 51902d4ac53ca7ef46baff38e75deec98321667d Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Fri, 14 Jun 2024 02:09:55 -0400
Subject: [PATCH] Updated headers with latest wikiheaders tweaks.

---
 include/SDL3/SDL_assert.h     |  28 +-
 include/SDL3/SDL_atomic.h     |  36 +--
 include/SDL3/SDL_audio.h      | 160 ++++++------
 include/SDL3/SDL_bits.h       |   4 +-
 include/SDL3/SDL_blendmode.h  |  12 +-
 include/SDL3/SDL_camera.h     |  28 +-
 include/SDL3/SDL_clipboard.h  |  32 +--
 include/SDL3/SDL_dialog.h     |  42 +--
 include/SDL3/SDL_error.h      |   8 +-
 include/SDL3/SDL_events.h     |  54 ++--
 include/SDL3/SDL_filesystem.h |  26 +-
 include/SDL3/SDL_gamepad.h    | 220 ++++++++--------
 include/SDL3/SDL_guid.h       |   8 +-
 include/SDL3/SDL_haptic.h     |  86 ++++---
 include/SDL3/SDL_hidapi.h     |  90 +++----
 include/SDL3/SDL_hints.h      |  42 +--
 include/SDL3/SDL_init.h       |   2 +-
 include/SDL3/SDL_iostream.h   | 172 ++++++-------
 include/SDL3/SDL_joystick.h   | 184 ++++++-------
 include/SDL3/SDL_keyboard.h   |  26 +-
 include/SDL3/SDL_loadso.h     |   8 +-
 include/SDL3/SDL_log.h        |  83 +++---
 include/SDL3/SDL_main.h       |  32 +--
 include/SDL3/SDL_messagebox.h |  13 +-
 include/SDL3/SDL_metal.h      |  10 +-
 include/SDL3/SDL_misc.h       |   2 +-
 include/SDL3/SDL_mouse.h      |  50 ++--
 include/SDL3/SDL_mutex.h      |  54 ++--
 include/SDL3/SDL_pen.h        |  32 +--
 include/SDL3/SDL_pixels.h     |  88 +++----
 include/SDL3/SDL_properties.h |  98 +++----
 include/SDL3/SDL_rect.h       |  68 ++---
 include/SDL3/SDL_render.h     | 470 +++++++++++++++++-----------------
 include/SDL3/SDL_sensor.h     |  36 +--
 include/SDL3/SDL_stdinc.h     | 242 ++++++++---------
 include/SDL3/SDL_storage.h    |  80 +++---
 include/SDL3/SDL_surface.h    | 251 +++++++++---------
 include/SDL3/SDL_system.h     |  52 ++--
 include/SDL3/SDL_thread.h     |  26 +-
 include/SDL3/SDL_time.h       |  44 ++--
 include/SDL3/SDL_timer.h      |  22 +-
 include/SDL3/SDL_touch.h      |   6 +-
 include/SDL3/SDL_video.h      | 340 ++++++++++++------------
 include/SDL3/SDL_vulkan.h     |  18 +-
 44 files changed, 1699 insertions(+), 1686 deletions(-)

diff --git a/include/SDL3/SDL_assert.h b/include/SDL3/SDL_assert.h
index caf5eac5afbe6..9d11c9d3274d1 100644
--- a/include/SDL3/SDL_assert.h
+++ b/include/SDL3/SDL_assert.h
@@ -234,11 +234,11 @@ typedef struct SDL_AssertData
  *
  * Use the SDL_assert* macros instead.
  *
- * \param data assert data structure
- * \param func function name
- * \param file file name
- * \param line line number
- * \returns assert state
+ * \param data assert data structure.
+ * \param func function name.
+ * \param file file name.
+ * \param line line number.
+ * \returns assert state.
  *
  * \since This function is available since SDL 3.0.0.
  */
@@ -306,7 +306,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
  * Note that SDL_ASSERT is an _environment variable_ and not an SDL hint!
  * Please refer to your platform's documentation for how to set it!
  *
- * \param condition boolean value to test
+ * \param condition boolean value to test.
  *
  * \since This macro is available since SDL 3.0.0.
  */
@@ -339,7 +339,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
  * Note that SDL_ASSERT is an _environment variable_ and not an SDL hint!
  * Please refer to your platform's documentation for how to set it!
  *
- * \param condition boolean value to test
+ * \param condition boolean value to test.
  *
  * \since This macro is available since SDL 3.0.0.
  */
@@ -369,7 +369,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
  * Note that SDL_ASSERT is an _environment variable_ and not an SDL hint!
  * Please refer to your platform's documentation for how to set it!
  *
- * \param condition boolean value to test
+ * \param condition boolean value to test.
  *
  * \since This macro is available since SDL 3.0.0.
  */
@@ -415,7 +415,7 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
  * Note that SDL_ASSERT is an _environment variable_ and not an SDL hint!
  * Please refer to your platform's documentation for how to set it!
  *
- * \param condition boolean value to test
+ * \param condition boolean value to test.
  *
  * \since This macro is available since SDL 3.0.0.
  */
@@ -426,8 +426,8 @@ extern SDL_DECLSPEC SDL_AssertState SDLCALL SDL_ReportAssertion(SDL_AssertData *
  * A callback that fires when an SDL assertion fails.
  *
  * \param data a pointer to the SDL_AssertData structure corresponding to the
- *             current assertion
- * \param userdata what was passed as `userdata` to SDL_SetAssertionHandler()
+ *             current assertion.
+ * \param userdata what was passed as `userdata` to SDL_SetAssertionHandler().
  * \returns an SDL_AssertState value indicating how to handle the failure.
  *
  * \since This datatype is available since SDL 3.0.0.
@@ -449,8 +449,8 @@ typedef SDL_AssertState (SDLCALL *SDL_AssertionHandler)(
  * This callback is NOT reset to SDL's internal handler upon SDL_Quit()!
  *
  * \param handler the SDL_AssertionHandler function to call when an assertion
- *                fails or NULL for the default handler
- * \param userdata a pointer that is passed to `handler`
+ *                fails or NULL for the default handler.
+ * \param userdata a pointer that is passed to `handler`.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -491,7 +491,7 @@ extern SDL_DECLSPEC SDL_AssertionHandler SDLCALL SDL_GetDefaultAssertionHandler(
  * data, it is safe to pass a NULL pointer to this function to ignore it.
  *
  * \param puserdata pointer which is filled with the "userdata" pointer that
- *                  was passed to SDL_SetAssertionHandler()
+ *                  was passed to SDL_SetAssertionHandler().
  * \returns the SDL_AssertionHandler that is called when an assert triggers.
  *
  * \since This function is available since SDL 3.0.0.
diff --git a/include/SDL3/SDL_atomic.h b/include/SDL3/SDL_atomic.h
index 5bf0cf9aa1e48..90594b5ef301e 100644
--- a/include/SDL3/SDL_atomic.h
+++ b/include/SDL3/SDL_atomic.h
@@ -87,7 +87,7 @@ typedef int SDL_SpinLock;
  * ***Please note that spinlocks are dangerous if you don't know what you're
  * doing. Please be careful using any sort of spinlock!***
  *
- * \param lock a pointer to a lock variable
+ * \param lock a pointer to a lock variable.
  * \returns SDL_TRUE if the lock succeeded, SDL_FALSE if the lock is already
  *          held.
  *
@@ -104,7 +104,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_TryLockSpinlock(SDL_SpinLock *lock);
  * ***Please note that spinlocks are dangerous if you don't know what you're
  * doing. Please be careful using any sort of spinlock!***
  *
- * \param lock a pointer to a lock variable
+ * \param lock a pointer to a lock variable.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -121,7 +121,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockSpinlock(SDL_SpinLock *lock);
  * ***Please note that spinlocks are dangerous if you don't know what you're
  * doing. Please be careful using any sort of spinlock!***
  *
- * \param lock a pointer to a lock variable
+ * \param lock a pointer to a lock variable.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -333,9 +333,9 @@ typedef struct SDL_AtomicInt { int value; } SDL_AtomicInt;
  * ***Note: If you don't know what this function is for, you shouldn't use
  * it!***
  *
- * \param a a pointer to an SDL_AtomicInt variable to be modified
- * \param oldval the old value
- * \param newval the new value
+ * \param a a pointer to an SDL_AtomicInt variable to be modified.
+ * \param oldval the old value.
+ * \param newval the new value.
  * \returns SDL_TRUE if the atomic variable was set, SDL_FALSE otherwise.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -354,8 +354,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_AtomicCompareAndSwap(SDL_AtomicInt *a,
  * ***Note: If you don't know what this function is for, you shouldn't use
  * it!***
  *
- * \param a a pointer to an SDL_AtomicInt variable to be modified
- * \param v the desired value
+ * \param a a pointer to an SDL_AtomicInt variable to be modified.
+ * \param v the desired value.
  * \returns the previous value of the atomic variable.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -372,7 +372,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AtomicSet(SDL_AtomicInt *a, int v);
  * ***Note: If you don't know what this function is for, you shouldn't use
  * it!***
  *
- * \param a a pointer to an SDL_AtomicInt variable
+ * \param a a pointer to an SDL_AtomicInt variable.
  * \returns the current value of an atomic variable.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -391,8 +391,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_AtomicGet(SDL_AtomicInt *a);
  * ***Note: If you don't know what this function is for, you shouldn't use
  * it!***
  *
- * \param a a pointer to an SDL_AtomicInt variable to be modified
- * \param v the desired value to add
+ * \param a a pointer to an SDL_AtomicInt variable to be modified.
+ * \param v the desired value to add.
  * \returns the previous value of the atomic variable.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -430,7 +430,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_AtomicAdd(SDL_AtomicInt *a, int v);
  *
  * \param a a pointer to an SDL_AtomicInt to increment.
  * \returns SDL_TRUE if the variable reached zero after decrementing,
- *          SDL_FALSE otherwise
+ *          SDL_FALSE otherwise.
  *
  * \since This macro is available since SDL 3.0.0.
  *
@@ -445,9 +445,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_AtomicAdd(SDL_AtomicInt *a, int v);
  * ***Note: If you don't know what this function is for, you shouldn't use
  * it!***
  *
- * \param a a pointer to a pointer
- * \param oldval the old pointer value
- * \param newval the new pointer value
+ * \param a a pointer to a pointer.
+ * \param oldval the old pointer value.
+ * \param newval the new pointer value.
  * \returns SDL_TRUE if the pointer was set, SDL_FALSE otherwise.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -466,8 +466,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_AtomicCompareAndSwapPointer(void **a, v
  * ***Note: If you don't know what this function is for, you shouldn't use
  * it!***
  *
- * \param a a pointer to a pointer
- * \param v the desired pointer value
+ * \param a a pointer to a pointer.
+ * \param v the desired pointer value.
  * \returns the previous value of the pointer.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -485,7 +485,7 @@ extern SDL_DECLSPEC void* SDLCALL SDL_AtomicSetPtr(void **a, void* v);
  * ***Note: If you don't know what this function is for, you shouldn't use
  * it!***
  *
- * \param a a pointer to a pointer
+ * \param a a pointer to a pointer.
  * \returns the current value of a pointer.
  *
  * \threadsafety It is safe to call this function from any thread.
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index 08ec2928f3f08..162b0d7a16f1c 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -141,8 +141,8 @@ typedef Uint16 SDL_AudioFormat;
  *
  * For example, `SDL_AUDIO_BITSIZE(SDL_AUDIO_S16)` returns 16.
  *
- * \param x an SDL_AudioFormat value
- * \returns data size in bits
+ * \param x an SDL_AudioFormat value.
+ * \returns data size in bits.
  *
  * \threadsafety It is safe to call this macro from any thread.
  *
@@ -155,8 +155,8 @@ typedef Uint16 SDL_AudioFormat;
  *
  * For example, `SDL_AUDIO_BYTESIZE(SDL_AUDIO_S16)` returns 2.
  *
- * \param x an SDL_AudioFormat value
- * \returns data size in bytes
+ * \param x an SDL_AudioFormat value.
+ * \returns data size in bytes.
  *
  * \threadsafety It is safe to call this macro from any thread.
  *
@@ -169,7 +169,7 @@ typedef Uint16 SDL_AudioFormat;
  *
  * For example, `SDL_AUDIO_ISFLOAT(SDL_AUDIO_S16)` returns 0.
  *
- * \param x an SDL_AudioFormat value
+ * \param x an SDL_AudioFormat value.
  * \returns non-zero if format is floating point, zero otherwise.
  *
  * \threadsafety It is safe to call this macro from any thread.
@@ -183,7 +183,7 @@ typedef Uint16 SDL_AudioFormat;
  *
  * For example, `SDL_AUDIO_ISBIGENDIAN(SDL_AUDIO_S16LE)` returns 0.
  *
- * \param x an SDL_AudioFormat value
+ * \param x an SDL_AudioFormat value.
  * \returns non-zero if format is bigendian, zero otherwise.
  *
  * \threadsafety It is safe to call this macro from any thread.
@@ -197,7 +197,7 @@ typedef Uint16 SDL_AudioFormat;
  *
  * For example, `SDL_AUDIO_ISLITTLEENDIAN(SDL_AUDIO_S16BE)` returns 0.
  *
- * \param x an SDL_AudioFormat value
+ * \param x an SDL_AudioFormat value.
  * \returns non-zero if format is littleendian, zero otherwise.
  *
  * \threadsafety It is safe to call this macro from any thread.
@@ -211,7 +211,7 @@ typedef Uint16 SDL_AudioFormat;
  *
  * For example, `SDL_AUDIO_ISSIGNED(SDL_AUDIO_U8)` returns 0.
  *
- * \param x an SDL_AudioFormat value
+ * \param x an SDL_AudioFormat value.
  * \returns non-zero if format is signed, zero otherwise.
  *
  * \threadsafety It is safe to call this macro from any thread.
@@ -225,7 +225,7 @@ typedef Uint16 SDL_AudioFormat;
  *
  * For example, `SDL_AUDIO_ISINT(SDL_AUDIO_F32)` returns 0.
  *
- * \param x an SDL_AudioFormat value
+ * \param x an SDL_AudioFormat value.
  * \returns non-zero if format is integer, zero otherwise.
  *
  * \threadsafety It is safe to call this macro from any thread.
@@ -239,7 +239,7 @@ typedef Uint16 SDL_AudioFormat;
  *
  * For example, `SDL_AUDIO_ISUNSIGNED(SDL_AUDIO_S16)` returns 0.
  *
- * \param x an SDL_AudioFormat value
+ * \param x an SDL_AudioFormat value.
  * \returns non-zero if format is unsigned, zero otherwise.
  *
  * \threadsafety It is safe to call this macro from any thread.
@@ -382,7 +382,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(void);
  * The returned string follows the SDL_GetStringRule.
  *
  * \param index the index of the audio driver; the value ranges from 0 to
- *              SDL_GetNumAudioDrivers() - 1
+ *              SDL_GetNumAudioDrivers() - 1.
  * \returns the name of the audio driver at the requested index, or NULL if an
  *          invalid index was specified.
  *
@@ -512,8 +512,8 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_GetAudioDeviceName(SDL_AudioDeviceID
  * playback timing. Most apps do not need this.
  *
  * \param devid the instance ID of the device to query.
- * \param spec On return, will be filled with device details.
- * \param sample_frames Pointer to store device buffer size, in sample frames.
+ * \param spec on return, will be filled with device details.
+ * \param sample_frames pointer to store device buffer size, in sample frames.
  *                      Can be NULL.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
@@ -618,7 +618,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_OpenAudioDevice(SDL_AudioDevic
  * Physical devices can not be paused or unpaused, only logical devices
  * created through SDL_OpenAudioDevice() can be.
  *
- * \param dev a device opened by SDL_OpenAudioDevice()
+ * \param dev a device opened by SDL_OpenAudioDevice().
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -646,7 +646,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev);
  * Physical devices can not be paused or unpaused, only logical devices
  * created through SDL_OpenAudioDevice() can be.
  *
- * \param dev a device opened by SDL_OpenAudioDevice()
+ * \param dev a device opened by SDL_OpenAudioDevice().
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -669,7 +669,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_ResumeAudioDevice(SDL_AudioDeviceID dev);
  * created through SDL_OpenAudioDevice() can be. Physical and invalid device
  * IDs will report themselves as unpaused here.
  *
- * \param dev a device opened by SDL_OpenAudioDevice()
+ * \param dev a device opened by SDL_OpenAudioDevice().
  * \returns SDL_TRUE if device is valid and paused, SDL_FALSE otherwise.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -692,7 +692,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_AudioDevicePaused(SDL_AudioDeviceID dev
  * supplied if terminating immediately afterwards.
  *
  * \param devid an audio device id previously returned by
- *              SDL_OpenAudioDevice()
+ *              SDL_OpenAudioDevice().
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -725,7 +725,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID devid);
  *
  * \param devid an audio device to bind a stream to.
  * \param streams an array of audio streams to unbind.
- * \param num_streams Number streams listed in the `streams` array.
+ * \param num_streams number streams listed in the `streams` array.
  * \returns 0 on success, -1 on error; call SDL_GetError() for more
  *          information.
  *
@@ -770,7 +770,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_BindAudioStream(SDL_AudioDeviceID devid, SDL
  * Unbinding a stream that isn't bound to a device is a legal no-op.
  *
  * \param streams an array of audio streams to unbind.
- * \param num_streams Number streams listed in the `streams` array.
+ * \param num_streams number streams listed in the `streams` array.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -819,8 +819,8 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_GetAudioStreamDevice(SDL_Audio
 /**
  * Create a new audio stream.
  *
- * \param src_spec The format details of the input audio
- * \param dst_spec The format details of the output audio
+ * \param src_spec the format details of the input audio.
+ * \param dst_spec the format details of the output audio.
  * \returns a new audio stream on success, or NULL on failure.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -840,7 +840,7 @@ extern SDL_DECLSPEC SDL_AudioStream *SDLCALL SDL_CreateAudioStream(const SDL_Aud
 /**
  * Get the properties associated with an audio stream.
  *
- * \param stream the SDL_AudioStream to query
+ * \param stream the SDL_AudioStream to query.
  * \returns a valid property ID on success or 0 on failure; call
  *          SDL_GetError() for more information.
  *
@@ -855,8 +855,8 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetAudioStreamProperties(SDL_Au
  * Query the current format of an audio stream.
  *
  * \param stream the SDL_AudioStream to query.
- * \param src_spec Where to store the input audio format; ignored if NULL.
- * \param dst_spec Where to store the output audio format; ignored if NULL.
+ * \param src_spec where to store the input audio format; ignored if NULL.
+ * \param dst_spec where to store the output audio format; ignored if NULL.
  * \returns 0 on success, or -1 on error.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
@@ -881,10 +881,10 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamFormat(SDL_AudioStream *stream
  * next sound file, and start putting that new data while the previous sound
  * file is still queued, and everything will still play back correctly.
  *
- * \param stream The stream the format is being changed
- * \param src_spec The new format of the audio input; if NULL, it is not
+ * \param stream the stream the format is being changed.
+ * \param src_spec the new format of the audio input; if NULL, it is not
  *                 changed.
- * \param dst_spec The new format of the audio output; if NULL, it is not
+ * \param dst_spec the new format of the audio output; if NULL, it is not
  *                 changed.
  * \returns 0 on success, or -1 on error.
  *
@@ -904,7 +904,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetAudioStreamFormat(SDL_AudioStream *stream
  * Get the frequency ratio of an audio stream.
  *
  * \param stream the SDL_AudioStream to query.
- * \returns the frequency ratio of the stream, or 0.0 on error
+ * \returns the frequency ratio of the stream, or 0.0 on error.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
  *               a stream-specific mutex while running.
@@ -927,8 +927,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStre
  * This is applied during SDL_GetAudioStreamData, and can be continuously
  * changed to create various effects.
  *
- * \param stream The stream the frequency ratio is being changed
- * \param ratio The frequency ratio. 1.0 is normal speed. Must be between 0.01
+ * \param stream the stream the frequency ratio is being changed.
+ * \param ratio the frequency ratio. 1.0 is normal speed. Must be between 0.01
  *              and 100.
  * \returns 0 on success, or -1 on error.
  *
@@ -953,9 +953,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetAudioStreamFrequencyRatio(SDL_AudioStream
  * different than SDL2, where data was converted during the Put call and the
  * Get call would just dequeue the previously-converted data.
  *
- * \param stream The stream the audio data is being added to
- * \param buf A pointer to the audio data to add
- * \param len The number of bytes to write to the stream
+ * \param stream the stream the audio data is being added to.
+ * \param buf a pointer to the audio data to add.
+ * \param len the number of bytes to write to the stream.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -984,10 +984,10 @@ extern SDL_DECLSPEC int SDLCALL SDL_PutAudioStreamData(SDL_AudioStream *stream,
  * is different than SDL2, where that work was done while inputting new data
  * to the stream and requesting the output just copied the converted data.
  *
- * \param stream The stream the audio is being requested from
- * \param buf A buffer to fill with audio data
- * \param len The maximum number of bytes to fill
- * \returns the number of bytes read from the stream, or -1 on error
+ * \param stream the stream the audio is being requested from.
+ * \param buf a buffer to fill with audio data.
+ * \param len the maximum number of bytes to fill.
+ * \returns the number of bytes read from the stream, or -1 on error.
  *
  * \threadsafety It is safe to call this function from any thread, but if the
  *               stream has a callback set, the caller might need to manage
@@ -1014,7 +1014,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamData(SDL_AudioStream *stream,
  * SDL_GetAudioStreamData before this function's return value is no longer
  * clamped.
  *
- * \param stream The audio stream to query
+ * \param stream the audio stream to query.
  * \returns the number of converted/resampled bytes available.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -1046,7 +1046,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *str
  * SDL_GetAudioStreamData before this function's return value is no longer
  * clamped.
  *
- * \param stream The audio stream to query
+ * \param stream the audio stream to query.
  * \returns the number of bytes queued.
  *
  * \threadsafety It is safe to call this function from any thread.
@@ -1067,7 +1067,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamQueued(SDL_AudioStream *stream
  * audio gaps in the output. Generally this is intended to signal the end of
  * input, so the complete output becomes available.
  *
- * \param stream The audio stream to flush
+ * \param stream the audio stream to flush.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1085,7 +1085,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_FlushAudioStream(SDL_AudioStream *stream);
  * This drops any queued data, so there will be nothing to read from the
  * stream until more is added.
  *
- * \param stream The audio stream to clear
+ * \param stream the audio stream to clear.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1112,7 +1112,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_ClearAudioStream(SDL_AudioStream *stream);
  * audio streams. This might be useful while a game is paused, or a level is
  * loading, etc.
  *
- * \param stream The audio stream associated with the audio device to pause
+ * \param stream the audio stream associated with the audio device to pause.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1132,7 +1132,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_PauseAudioStreamDevice(SDL_AudioStream *stre
  * previously been paused. Once unpaused, any bound audio streams will begin
  * to progress again, and audio can be generated.
  *
- * \param stream The audio stream associated with the audio device to resume
+ * \param stream the audio stream associated with the audio device to resume.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1160,7 +1160,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_ResumeAudioStreamDevice(SDL_AudioStream *str
  * As this is just a wrapper over SDL_LockMutex for an internal lock; it has
  * all the same attributes (recursive locks are allowed, etc).
  *
- * \param stream The audio stream to lock.
+ * \param stream the audio stream to lock.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1178,7 +1178,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_LockAudioStream(SDL_AudioStream *stream);
  *
  * This unlocks an audio stream after a call to SDL_LockAudioStream.
  *
- * \param stream The audio stream to unlock.
+ * \param stream the audio stream to unlock.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1212,12 +1212,12 @@ extern SDL_DECLSPEC int SDLCALL SDL_UnlockAudioStream(SDL_AudioStream *stream);
  * appropriate, but the system goes on with the data currently available to it
  * if this callback does nothing.
  *
- * \param stream The SDL audio stream associated with this callback.
- * \param additional_amount The amount of data, in bytes, that is needed right
+ * \param stream the SDL audio stream associated with this callback.
+ * \param additional_amount the amount of data, in bytes, that is needed right
  *                          now.
- * \param total_amount The total amount of data requested, in bytes, that is
+ * \param total_amount the total amount of data requested, in bytes, that is
  *                     requested or available.
- * \param userdata An opaque pointer provided by the app for their personal
+ * \param userdata an opaque pointer provided by the app for their personal
  *                 use.
  *
  * \threadsafety This callbacks may run from any thread, so if you need to
@@ -1338,7 +1338,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetAudioStreamPutCallback(SDL_AudioStream *s
  * device that was opened alongside this stream's creation will be closed,
  * too.
  *
- * \param stream The audio stream to destroy.
+ * \param stream the audio stream to destroy.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1390,11 +1390,11 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyAudioStream(SDL_AudioStream *stream)
  * \param devid an audio device to open, or SDL_AUDIO_DEVICE_DEFAULT_OUTPUT or
  *              SDL_AUDIO_DEVICE_DEFAULT_CAPTURE.
  * \param spec the audio stream's data format. Can be NULL.
- * \param callback A callback where the app will provide new data for
+ * \param callback a callback where the app will provide new data for
  *                 playback, or receive new data for capture. Can be NULL, in
  *                 which case the app will need to call SDL_PutAudioStreamData
  *                 or SDL_GetAudioStreamData as necessary.
- * \param userdata App-controlled pointer passed to callback. Can be NULL.
+ * \param userdata app-controlled pointer passed to callback. Can be NULL.
  *                 Ignored if callback is NULL.
  * \returns an audio stream on success, ready to use. NULL on error; call
  *          SDL_GetError() for more information. When done with this stream,
@@ -1485,9 +1485,9 @@ typedef void (SDLCALL *SDL_AudioPostmixCallback)(void *userdata, const SDL_Audio
  *
  * Setting a NULL callback function disables any previously-set callback.
  *
- * \param devid The ID of an opened audio device.
- * \param callback A callback function to be called. Can be NULL.
- * \param userdata App-controlled pointer passed to callback. Can be NULL.
+ * \param devid the ID of an opened audio device.
+ * \param callback a callback function to be called. Can be NULL.
+ * \param userdata app-controlled pointer passed to callback. Can be NULL.
  * \returns zero on success, -1 on error; call SDL_GetError() for more
  *          information.
  *
@@ -1549,15 +1549,15 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID de
  * SDL_LoadWAV("sample.wav", &spec, &buf, &len);
  * ```
  *
- * \param src The data source for the WAVE data
- * \param closeio If SDL_TRUE, calls SDL_CloseIO() on `src` before returning,
- *                even in the case of an error
- * \param spec A pointer to an SDL_AudioSpec that will be set to the WAVE
- *             data's format details on successful return
- * \param audio_buf A pointer filled with the audio data, allocated by the
- *                  function
- * \param audio_len A pointer filled with the length of the audio data buffer
- *                  in bytes
+ * \param src the data source for the WAVE data.
+ * \param closeio if SDL_TRUE, calls SDL_CloseIO() on `src` before returning,
+ *                even in the case of an error.
+ * \param spec a pointer to an SDL_AudioSpec that will be set to the WAVE
+ *             data's format details on successful return.
+ * \param audio_buf a pointer filled with the audio data, allocated by the
+ *                  function.
+ * \param audio_len a pointer filled with the length of the audio data buffer
+ *                  in bytes.
  * \returns 0 on success. `audio_buf` will be filled with a pointer to an
  *          allocated buffer containing the audio data, and `audio_len` is
  *          filled with the length of that audio buffer in bytes.
@@ -1589,13 +1589,13 @@ extern SDL_DECLSPEC int SDLCALL SDL_LoadWAV_IO(SDL_IOStream * src, SDL_bool clos
  * SDL_LoadWAV_IO(SDL_IOFromFile(path, "rb"), 1, spec, audio_buf, audio_len);
  * ```
  *
- * \param path The file path of the WAV file to open.
- * \param spec A pointer to an SDL_AudioSpec that will be set to the WAVE
+ * \param path the file path of the WAV file to open.
+ * \param spec a pointer to an SDL_AudioSpec that will be set to the WAVE
  *             data's format details on successful return.
- * \param audio_buf A pointer filled with the audio data, allocated by the
+ * \param audio_buf a pointer filled with the audio data, allocated by the
  *                  function.
- * \param audio_len A pointer filled with the length of the audio data buffer
- *                  in bytes
+ * \param audio_len a pointer filled with the length of the audio data buffer
+ *                  in bytes.
  * \ret

(Patch may be truncated, please check the link at the top of this post.)