SDL: Sync SDL3 wiki -> header (026d3)

From 026d3c2306ffe71c5624969a0532735ed6e85275 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Wed, 18 Sep 2024 15:33:11 +0000
Subject: [PATCH] Sync SDL3 wiki -> header

---
 include/SDL3/SDL_atomic.h     |   7 +-
 include/SDL3/SDL_audio.h      | 116 +++++++--------
 include/SDL3/SDL_bits.h       |   3 +-
 include/SDL3/SDL_camera.h     |   8 +-
 include/SDL3/SDL_clipboard.h  |  23 ++-
 include/SDL3/SDL_cpuinfo.h    |   6 +-
 include/SDL3/SDL_error.h      |   4 +-
 include/SDL3/SDL_events.h     |  37 +++--
 include/SDL3/SDL_filesystem.h |  24 ++--
 include/SDL3/SDL_gamepad.h    |  55 ++++---
 include/SDL3/SDL_gpu.h        |  15 +-
 include/SDL3/SDL_haptic.h     |  48 +++----
 include/SDL3/SDL_hints.h      |  20 +--
 include/SDL3/SDL_init.h       |  16 +--
 include/SDL3/SDL_iostream.h   | 128 ++++++++---------
 include/SDL3/SDL_joystick.h   |  58 ++++----
 include/SDL3/SDL_keyboard.h   |  44 +++---
 include/SDL3/SDL_log.h        |   4 +-
 include/SDL3/SDL_main.h       |   4 +-
 include/SDL3/SDL_messagebox.h |   8 +-
 include/SDL3/SDL_misc.h       |   4 +-
 include/SDL3/SDL_mouse.h      |  31 ++--
 include/SDL3/SDL_mutex.h      |   4 +-
 include/SDL3/SDL_pixels.h     |   8 +-
 include/SDL3/SDL_process.h    |  20 +--
 include/SDL3/SDL_properties.h |  40 +++---
 include/SDL3/SDL_rect.h       |  16 +--
 include/SDL3/SDL_render.h     | 262 +++++++++++++++++-----------------
 include/SDL3/SDL_sensor.h     |   4 +-
 include/SDL3/SDL_stdinc.h     |  24 ++--
 include/SDL3/SDL_storage.h    |  46 +++---
 include/SDL3/SDL_surface.h    | 164 +++++++++++----------
 include/SDL3/SDL_system.h     |  49 +++----
 include/SDL3/SDL_thread.h     |   8 +-
 include/SDL3/SDL_time.h       |  16 +--
 include/SDL3/SDL_timer.h      |   4 +-
 include/SDL3/SDL_video.h      | 246 ++++++++++++++++---------------
 include/SDL3/SDL_vulkan.h     |  11 +-
 38 files changed, 779 insertions(+), 806 deletions(-)

diff --git a/include/SDL3/SDL_atomic.h b/include/SDL3/SDL_atomic.h
index 790eb661c36a3..0a9fa045feafd 100644
--- a/include/SDL3/SDL_atomic.h
+++ b/include/SDL3/SDL_atomic.h
@@ -88,8 +88,7 @@ typedef int SDL_SpinLock;
  * doing. Please be careful using any sort of spinlock!***
  *
  * \param lock a pointer to a lock variable.
- * \returns true if the lock succeeded, false if the lock is already
- *          held.
+ * \returns true if the lock succeeded, false if the lock is already held.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -431,8 +430,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddAtomicInt(SDL_AtomicInt *a, int v);
  * ***Note: If you don't know what this macro is for, you shouldn't use it!***
  *
  * \param a a pointer to an SDL_AtomicInt to increment.
- * \returns true if the variable reached zero after decrementing,
- *          false otherwise.
+ * \returns true if the variable reached zero after decrementing, false
+ *          otherwise.
  *
  * \since This macro is available since SDL 3.0.0.
  *
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index c6cd3fde02914..7ac0d5be2cccc 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -532,8 +532,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioDeviceName(SDL_AudioDeviceI
  * \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 true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -659,8 +659,8 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_OpenAudioDevice(SDL_AudioDevic
  * created through SDL_OpenAudioDevice() can be.
  *
  * \param dev a device opened by SDL_OpenAudioDevice().
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -687,8 +687,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev);
  * created through SDL_OpenAudioDevice() can be.
  *
  * \param dev a device opened by SDL_OpenAudioDevice().
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -753,10 +753,10 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioDeviceGain(SDL_AudioDeviceID devid
  * Audio devices default to a gain of 1.0f (no change in output).
  *
  * Physical devices may not have their gain changed, only logical devices, and
- * this function will always return false when used on physical devices.
- * While it might seem attractive to adjust several logical devices at once in
- * this way, it would allow an app or library to interfere with another
- * portion of the program's otherwise-isolated devices.
+ * this function will always return false when used on physical devices. While
+ * it might seem attractive to adjust several logical devices at once in this
+ * way, it would allow an app or library to interfere with another portion of
+ * the program's otherwise-isolated devices.
  *
  * This is applied, along with any per-audiostream gain, during playback to
  * the hardware, and can be continuously changed to create various effects. On
@@ -767,8 +767,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioDeviceGain(SDL_AudioDeviceID devid
  *
  * \param devid the audio device on which to change gain.
  * \param gain the gain. 1.0f is no change, 0.0f is silence.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
  *               a stream-specific mutex while running.
@@ -824,8 +824,8 @@ 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 bind.
  * \param num_streams number streams listed in the `streams` array.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -845,8 +845,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BindAudioStreams(SDL_AudioDeviceID devid, S
  *
  * \param devid an audio device to bind a stream to.
  * \param stream an audio stream to bind to a device.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -953,8 +953,8 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetAudioStreamProperties(SDL_Au
  * \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.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
  *               a stream-specific mutex while running.
@@ -983,8 +983,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetAudioStreamFormat(SDL_AudioStream *strea
  *                 changed.
  * \param dst_spec the new format of the audio output; if NULL, it is not
  *                 changed.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
  *               a stream-specific mutex while running.
@@ -1027,8 +1027,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStre
  * \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 true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
  *               a stream-specific mutex while running.
@@ -1074,8 +1074,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamGain(SDL_AudioStream *stream
  *
  * \param stream the stream on which the gain is being changed.
  * \param gain the gain. 1.0f is no change, 0.0f is silence.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
  *               a stream-specific mutex while running.
@@ -1171,8 +1171,8 @@ extern SDL_DECLSPEC int * SDLCALL SDL_GetAudioStreamOutputChannelMap(SDL_AudioSt
  * \param stream the SDL_AudioStream to change.
  * \param chmap the new channel map, NULL to reset to default.
  * \param count The number of channels in the map.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
  *               a stream-specific mutex while running. Don't change the
@@ -1218,8 +1218,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamInputChannelMap(SDL_AudioStre
  * \param stream the SDL_AudioStream to change.
  * \param chmap the new channel map, NULL to reset to default.
  * \param count The number of channels in the map.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds
  *               a stream-specific mutex while running. Don't change the
@@ -1246,8 +1246,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamOutputChannelMap(SDL_AudioStr
  * \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 true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \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
@@ -1361,8 +1361,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamQueued(SDL_AudioStream *stream
  * input, so the complete output becomes available.
  *
  * \param stream the audio stream to flush.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1379,8 +1379,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlushAudioStream(SDL_AudioStream *stream);
  * stream until more is added.
  *
  * \param stream the audio stream to clear.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1406,8 +1406,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearAudioStream(SDL_AudioStream *stream);
  * loading, etc.
  *
  * \param stream the audio stream associated with the audio device to pause.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1426,8 +1426,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseAudioStreamDevice(SDL_AudioStream *str
  * to progress again, and audio can be generated.
  *
  * \param stream the audio stream associated with the audio device to resume.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1454,8 +1454,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ResumeAudioStreamDevice(SDL_AudioStream *st
  * all the same attributes (recursive locks are allowed, etc).
  *
  * \param stream the audio stream to lock.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1472,8 +1472,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockAudioStream(SDL_AudioStream *stream);
  * This unlocks an audio stream after a call to SDL_LockAudioStream.
  *
  * \param stream the audio stream to unlock.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety You should only call this from the same thread that
  *               previously called SDL_LockAudioStream.
@@ -1561,8 +1561,8 @@ typedef void (SDLCALL *SDL_AudioStreamCallback)(void *userdata, SDL_AudioStream
  *                 from the stream.
  * \param userdata an opaque pointer provided to the callback for its own
  *                 personal use.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information. This only fails if `stream` is NULL.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information. This only fails if `stream` is NULL.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1610,8 +1610,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamGetCallback(SDL_AudioStream *
  *                 stream.
  * \param userdata an opaque pointer provided to the callback for its own
  *                 personal use.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information. This only fails if `stream` is NULL.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information. This only fails if `stream` is NULL.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1788,8 +1788,8 @@ typedef void (SDLCALL *SDL_AudioPostmixCallback)(void *userdata, const SDL_Audio
  * \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 true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1850,16 +1850,16 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID d
  * ```
  *
  * \param src the data source for the WAVE data.
- * \param closeio if true, calls SDL_CloseIO() on `src` before returning,
- *                even in the case of an error.
+ * \param closeio if 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 true on success. `audio_buf` will be filled with a pointer to
- *          an allocated buffer containing the audio data, and `audio_len` is
+ * \returns true 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.
  *
  *          This function returns false if the .WAV file cannot be opened,
@@ -1894,8 +1894,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LoadWAV_IO(SDL_IOStream *src, bool closeio,
  *                  function.
  * \param audio_len a pointer filled with the length of the audio data buffer
  *                  in bytes.
- * \returns true on success. `audio_buf` will be filled with a pointer to
- *          an allocated buffer containing the audio data, and `audio_len` is
+ * \returns true 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.
  *
  *          This function returns false if the .WAV file cannot be opened,
@@ -1941,8 +1941,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LoadWAV(const char *path, SDL_AudioSpec *sp
  * \param len the length of the audio buffer in bytes.
  * \param volume ranges from 0.0 - 1.0, and should be set to 1.0 for full
  *               audio volume.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
@@ -1971,8 +1971,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_MixAudio(Uint8 *dst, const Uint8 *src, SDL_
  *                 which should be freed with SDL_free(). On error, it will be
  *                 NULL.
  * \param dst_len will be filled with the len of dst_data.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
diff --git a/include/SDL3/SDL_bits.h b/include/SDL3/SDL_bits.h
index 8a0ba37b35440..15548bc66d0a5 100644
--- a/include/SDL3/SDL_bits.h
+++ b/include/SDL3/SDL_bits.h
@@ -120,8 +120,7 @@ SDL_FORCE_INLINE int SDL_MostSignificantBitIndex32(Uint32 x)
  * Determine if a unsigned 32-bit value has exactly one bit set.
  *
  * If there are no bits set (`x` is zero), or more than one bit set, this
- * returns false. If any one bit is exclusively set, this returns
- * true.
+ * returns false. If any one bit is exclusively set, this returns true.
  *
  * Note that this is a forced-inline function in a header, and not a public
  * API function available in the SDL library (which is to say, the code is
diff --git a/include/SDL3/SDL_camera.h b/include/SDL3/SDL_camera.h
index 43fb1c435ac35..db2eb6940fe67 100644
--- a/include/SDL3/SDL_camera.h
+++ b/include/SDL3/SDL_camera.h
@@ -369,15 +369,15 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetCameraProperties(SDL_Camera
  * be converting to this format behind the scenes.
  *
  * If the system is waiting for the user to approve access to the camera, as
- * some platforms require, this will return false, but this isn't
- * necessarily a fatal error; you should either wait for an
+ * some platforms require, this will return false, but this isn't necessarily
+ * a fatal error; you should either wait for an
  * SDL_EVENT_CAMERA_DEVICE_APPROVED (or SDL_EVENT_CAMERA_DEVICE_DENIED) event,
  * or poll SDL_IsCameraApproved() occasionally until it returns non-zero.
  *
  * \param camera opened camera device.
  * \param spec the SDL_CameraSpec to be initialized by this function.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
diff --git a/include/SDL3/SDL_clipboard.h b/include/SDL3/SDL_clipboard.h
index 4979aabbb481f..0ec724ac5b1cf 100644
--- a/include/SDL3/SDL_clipboard.h
+++ b/include/SDL3/SDL_clipboard.h
@@ -46,8 +46,8 @@ extern "C" {
  * Put UTF-8 text into the clipboard.
  *
  * \param text the text to store in the clipboard.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -89,8 +89,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasClipboardText(void);
  * Put UTF-8 text into the primary selection.
  *
  * \param text the text to store in the primary selection.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -120,8 +120,7 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetPrimarySelectionText(void);
  * Query whether the primary selection exists and contains a non-empty text
  * string.
  *
- * \returns true if the primary selection has text, or false if it
- *          does not.
+ * \returns true if the primary selection has text, or false if it does not.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -185,8 +184,8 @@ typedef void (SDLCALL *SDL_ClipboardCleanupCallback)(void *userdata);
  * \param userdata an opaque pointer that will be forwarded to the callbacks.
  * \param mime_types a list of mime-types that are being offered.
  * \param num_mime_types the number of mime-types in the mime_types list.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -199,8 +198,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetClipboardData(SDL_ClipboardDataCallback
 /**
  * Clear the clipboard data.
  *
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -231,8 +230,8 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetClipboardData(const char *mime_type, s
  * Query whether there is data in the clipboard for the provided mime type.
  *
  * \param mime_type the mime type to check for data for.
- * \returns true if there exists data in clipboard for the provided mime
- *          type, false if it does not.
+ * \returns true if there exists data in clipboard for the provided mime type,
+ *          false if it does not.
  *
  * \since This function is available since SDL 3.0.0.
  *
diff --git a/include/SDL3/SDL_cpuinfo.h b/include/SDL3/SDL_cpuinfo.h
index 431d0de6cf5df..ef4a90c69766d 100644
--- a/include/SDL3/SDL_cpuinfo.h
+++ b/include/SDL3/SDL_cpuinfo.h
@@ -253,8 +253,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasNEON(void);
  * This always returns false on CPUs that aren't using LOONGARCH instruction
  * sets.
  *
- * \returns true if the CPU has LOONGARCH LSX features or false if
- *          not.
+ * \returns true if the CPU has LOONGARCH LSX features or false if not.
  *
  * \since This function is available since SDL 3.0.0.
  */
@@ -266,8 +265,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_HasLSX(void);
  * This always returns false on CPUs that aren't using LOONGARCH instruction
  * sets.
  *
- * \returns true if the CPU has LOONGARCH LASX features or false if
- *          not.
+ * \returns true if the CPU has LOONGARCH LASX features or false if not.
  *
  * \since This function is available since SDL 3.0.0.
  */
diff --git a/include/SDL3/SDL_error.h b/include/SDL3/SDL_error.h
index 1f5f65d1e72ae..ed79fc2dd051e 100644
--- a/include/SDL3/SDL_error.h
+++ b/include/SDL3/SDL_error.h
@@ -44,8 +44,8 @@ extern "C" {
  *
  * Calling this function will replace any previous error message that was set.
  *
- * This function always returns false, since SDL frequently uses false
- * to signify a failing result, leading to this idiom:
+ * This function always returns false, since SDL frequently uses false to
+ * signify a failing result, leading to this idiom:
  *
  * ```c
  * if (error_code) {
diff --git a/include/SDL3/SDL_events.h b/include/SDL3/SDL_events.h
index 34a7664cfbba5..e8fddab842e7d 100644
--- a/include/SDL3/SDL_events.h
+++ b/include/SDL3/SDL_events.h
@@ -1052,8 +1052,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event *events, int numevents,
  * instead.
  *
  * \param type the type of event to be queried; see SDL_EventType for details.
- * \returns true if events matching `type` are present, or false if
- *          events matching `type` are not present.
+ * \returns true if events matching `type` are present, or false if events
+ *          matching `type` are not present.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -1165,8 +1165,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_FlushEvents(Uint32 minType, Uint32 maxType)
  *
  * \param event the SDL_Event structure to be filled with the next event from
  *              the queue, or NULL.
- * \returns true if this got an event or false if there are none
- *          available.
+ * \returns true if this got an event or false if there are none available.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -1187,8 +1186,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PollEvent(SDL_Event *event);
  *
  * \param event the SDL_Event structure to be filled in with the next event
  *              from the queue, or NULL.
- * \returns true on success or false if there was an error while
- *          waiting for events; call SDL_GetError() for more information.
+ * \returns true on success or false if there was an error while waiting for
+ *          events; call SDL_GetError() for more information.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -1215,8 +1214,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitEvent(SDL_Event *event);
  *              from the queue, or NULL.
  * \param timeoutMS the maximum number of milliseconds to wait for the next
  *                  available event.
- * \returns true if this got an event or false if the timeout elapsed
- *          without any events available.
+ * \returns true if this got an event or false if the timeout elapsed without
+ *          any events available.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -1248,9 +1247,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitEventTimeout(SDL_Event *event, Sint32 t
  * its own custom event types.
  *
  * \param event the SDL_Event to be added to the queue.
- * \returns true on success, false if the event was filtered or on
- *          failure; call SDL_GetError() for more information. A common reason
- *          for error is the event queue being full.
+ * \returns true on success, false if the event was filtered or on failure;
+ *          call SDL_GetError() for more information. A common reason for
+ *          error is the event queue being full.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -1266,9 +1265,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PushEvent(SDL_Event *event);
  * \param userdata what was passed as `userdata` to SDL_SetEventFilter() or
  *                 SDL_AddEventWatch, etc.
  * \param event the event that triggered the callback.
- * \returns true to permit event to be added to the queue, and false
- *          to disallow it. When used with SDL_AddEventWatch, the return value
- *          is ignored.
+ * \returns true to permit event to be added to the queue, and false to
+ *          disallow it. When used with SDL_AddEventWatch, the return value is
+ *          ignored.
  *
  * \threadsafety SDL may call this callback at any time from any thread; the
  *               application is responsible for locking resources the callback
@@ -1286,9 +1285,9 @@ typedef bool (SDLCALL *SDL_EventFilter)(void *userdata, SDL_Event *event);
  * are posted to the internal event queue.
  *
  * If the filter function returns true when called, then the event will be
- * added to the internal queue. If it returns false, then the event will
- * be dropped from the queue, but the internal state will still be updated.
- * This allows selective filtering of dynamically arriving events.
+ * added to the internal queue. If it returns false, then the event will be
+ * dropped from the queue, but the internal state will still be updated. This
+ * allows selective filtering of dynamically arriving events.
  *
  * **WARNING**: Be very careful of what you do in the event filter function,
  * as it may run in a different thread!
@@ -1366,8 +1365,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetEventFilter(SDL_EventFilter *filter, voi
  *
  * \param filter an SDL_EventFilter function to call when an event happens.
  * \param userdata a pointer that is passed to `filter`.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \threadsafety It is safe to call this function from any thread.
  *
diff --git a/include/SDL3/SDL_filesystem.h b/include/SDL3/SDL_filesystem.h
index cd5941a4bacab..58d86efe14ac4 100644
--- a/include/SDL3/SDL_filesystem.h
+++ b/include/SDL3/SDL_filesystem.h
@@ -252,8 +252,8 @@ typedef Uint32 SDL_GlobFlags;
  * Create a directory.
  *
  * \param path the path of the directory to create.
- * \returns true on success or false on failure; call SDL_GetError()
- *          for more information.
+ * \returns true on success or false on failure; call SDL_GetError() for more
+ *          information.
  *
  * \since This function is available since SDL 3.0.0.
  */
@@ -275,8 +275,8 @@ typedef int (SDLCALL *SDL_EnumerateDirectoryCallback)(void *userdata, const char
  * \param path the path of the directory to enumerate.
  * \param callbac

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