From c53843a961add42c06a99f5f26980fe3072159c3 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Mon, 6 Nov 2023 10:26:06 -0500
Subject: [PATCH] docs: Remove Doxygen `\brief` tags.
Doxygen and the wiki bridge don't need them; they'll both just use the first
line/sentence instead.
Fixes #8446.
---
include/SDL3/SDL_assert.h | 2 +-
include/SDL3/SDL_atomic.h | 11 +-
include/SDL3/SDL_audio.h | 4 +-
include/SDL3/SDL_bits.h | 2 +-
include/SDL3/SDL_blendmode.h | 8 +-
include/SDL3/SDL_clipboard.h | 2 +-
include/SDL3/SDL_copying.h | 2 +-
include/SDL3/SDL_cpuinfo.h | 2 +-
include/SDL3/SDL_egl.h | 2 +-
include/SDL3/SDL_endian.h | 2 +-
include/SDL3/SDL_events.h | 68 ++--
include/SDL3/SDL_filesystem.h | 2 +-
include/SDL3/SDL_gamepad.h | 2 +-
include/SDL3/SDL_guid.h | 2 +-
include/SDL3/SDL_haptic.h | 71 ++--
include/SDL3/SDL_hidapi.h | 8 +-
include/SDL3/SDL_hints.h | 358 +++++++++---------
include/SDL3/SDL_init.h | 4 +-
include/SDL3/SDL_intrin.h | 2 +-
include/SDL3/SDL_joystick.h | 4 +-
include/SDL3/SDL_keyboard.h | 4 +-
include/SDL3/SDL_keycode.h | 6 +-
include/SDL3/SDL_loadso.h | 2 +-
include/SDL3/SDL_locale.h | 2 +-
include/SDL3/SDL_log.h | 8 +-
include/SDL3/SDL_main.h | 2 +-
include/SDL3/SDL_metal.h | 4 +-
include/SDL3/SDL_misc.h | 2 +-
include/SDL3/SDL_mouse.h | 6 +-
include/SDL3/SDL_mutex.h | 2 +-
include/SDL3/SDL_oldnames.h | 2 +-
include/SDL3/SDL_opengl.h | 2 +-
include/SDL3/SDL_opengles.h | 2 +-
include/SDL3/SDL_opengles2.h | 2 +-
include/SDL3/SDL_pixels.h | 2 +-
include/SDL3/SDL_platform.h | 2 +-
include/SDL3/SDL_platform_defines.h | 2 +-
include/SDL3/SDL_power.h | 2 +-
include/SDL3/SDL_properties.h | 2 +-
include/SDL3/SDL_quit.h | 2 +-
include/SDL3/SDL_rect.h | 2 +-
include/SDL3/SDL_render.h | 2 +-
include/SDL3/SDL_revision.h | 2 +-
include/SDL3/SDL_scancode.h | 4 +-
include/SDL3/SDL_sensor.h | 4 +-
include/SDL3/SDL_shape.h | 22 +-
include/SDL3/SDL_stdinc.h | 20 +-
include/SDL3/SDL_surface.h | 8 +-
include/SDL3/SDL_system.h | 22 +-
include/SDL3/SDL_syswm.h | 4 +-
include/SDL3/SDL_test.h | 2 +-
include/SDL3/SDL_test_assert.h | 18 +-
include/SDL3/SDL_test_common.h | 18 +-
include/SDL3/SDL_test_compare.h | 6 +-
include/SDL3/SDL_test_crc32.h | 8 +-
include/SDL3/SDL_test_font.h | 22 +-
include/SDL3/SDL_test_fuzzer.h | 2 +-
include/SDL3/SDL_test_harness.h | 6 +-
include/SDL3/SDL_test_log.h | 6 +-
include/SDL3/SDL_test_md5.h | 8 +-
include/SDL3/SDL_test_memory.h | 8 +-
include/SDL3/SDL_test_random.h | 8 +-
include/SDL3/SDL_thread.h | 2 +-
include/SDL3/SDL_timer.h | 2 +-
include/SDL3/SDL_touch.h | 2 +-
include/SDL3/SDL_version.h | 2 +-
include/SDL3/SDL_video.h | 26 +-
include/SDL3/SDL_vulkan.h | 2 +-
include/build_config/SDL_build_config.h | 2 +-
include/build_config/SDL_build_config.h.cmake | 2 +-
include/build_config/SDL_revision.h.cmake | 2 +-
src/core/linux/SDL_udev.h | 2 +-
src/hidapi/doxygen/Doxyfile | 2 +-
src/render/software/SDL_rotate.c | 16 +-
src/test/SDL_test_assert.c | 4 +-
src/test/SDL_test_font.c | 2 +-
src/test/SDL_test_harness.c | 10 +-
test/testautomation_audio.c | 36 +-
test/testautomation_clipboard.c | 6 +-
test/testautomation_events.c | 6 +-
test/testautomation_guid.c | 4 +-
test/testautomation_hints.c | 4 +-
test/testautomation_images.c | 22 +-
test/testautomation_intrinsics.c | 8 +-
test/testautomation_joystick.c | 2 +-
test/testautomation_keyboard.c | 28 +-
test/testautomation_main.c | 2 +-
test/testautomation_math.c | 10 +-
test/testautomation_mouse.c | 24 +-
test/testautomation_pixels.c | 6 +-
test/testautomation_platform.c | 24 +-
test/testautomation_properties.c | 6 +-
test/testautomation_rect.c | 78 ++--
test/testautomation_render.c | 36 +-
test/testautomation_rwops.c | 16 +-
test/testautomation_sdltest.c | 30 +-
test/testautomation_stdlib.c | 14 +-
test/testautomation_subsystems.c | 8 +-
test/testautomation_surface.c | 20 +-
test/testautomation_syswm.c | 2 +-
test/testautomation_timer.c | 8 +-
test/testautomation_video.c | 36 +-
test/testhaptic.c | 2 +-
test/testrumble.c | 2 +-
104 files changed, 669 insertions(+), 667 deletions(-)
diff --git a/include/SDL3/SDL_assert.h b/include/SDL3/SDL_assert.h
index e0addc2ee765..cdf1da17774b 100644
--- a/include/SDL3/SDL_assert.h
+++ b/include/SDL3/SDL_assert.h
@@ -22,7 +22,7 @@
/**
* \file SDL_assert.h
*
- * \brief Header file for assertion SDL API functions
+ * Header file for assertion SDL API functions
*/
#ifndef SDL_assert_h_
diff --git a/include/SDL3/SDL_atomic.h b/include/SDL3/SDL_atomic.h
index f0c652aa31e1..ece4ac5a3613 100644
--- a/include/SDL3/SDL_atomic.h
+++ b/include/SDL3/SDL_atomic.h
@@ -22,7 +22,7 @@
/**
* \file SDL_atomic.h
*
- * \brief Atomic operations.
+ * Atomic operations.
*
* IMPORTANT:
* If you are not an expert in concurrent lockless programming, you should
@@ -263,8 +263,9 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
/**
- * \brief A type representing an atomic integer value. It is a struct
- * so people don't accidentally use numeric operations on it.
+ * A type representing an atomic integer value.
+ *
+ * It is a struct so people don't accidentally use numeric operations on it.
*/
typedef struct { int value; } SDL_AtomicInt;
@@ -340,14 +341,14 @@ extern DECLSPEC int SDLCALL SDL_AtomicGet(SDL_AtomicInt *a);
extern DECLSPEC int SDLCALL SDL_AtomicAdd(SDL_AtomicInt *a, int v);
/**
- * \brief Increment an atomic variable used as a reference count.
+ * Increment an atomic variable used as a reference count.
*/
#ifndef SDL_AtomicIncRef
#define SDL_AtomicIncRef(a) SDL_AtomicAdd(a, 1)
#endif
/**
- * \brief Decrement an atomic variable used as a reference count.
+ * Decrement an atomic variable used as a reference count.
*
* \return SDL_TRUE if the variable reached zero after decrementing,
* SDL_FALSE otherwise
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index c6e5526d321d..7ce55ef20609 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -22,7 +22,7 @@
/**
* \file SDL_audio.h
*
- * \brief Audio functionality for the SDL library.
+ * Audio functionality for the SDL library.
*/
#ifndef SDL_audio_h_
@@ -54,7 +54,7 @@ extern "C" {
*/
/**
- * \brief Audio format flags.
+ * Audio format flags.
*
* These are what the 16 bits in SDL_AudioFormat currently mean...
* (Unspecified bits are always zero).
diff --git a/include/SDL3/SDL_bits.h b/include/SDL3/SDL_bits.h
index ffee5ad7cf87..1d7c09c173aa 100644
--- a/include/SDL3/SDL_bits.h
+++ b/include/SDL3/SDL_bits.h
@@ -22,7 +22,7 @@
/**
* \file SDL_bits.h
*
- * \brief Functions for fiddling with bits and bitmasks.
+ * Functions for fiddling with bits and bitmasks.
*/
#ifndef SDL_bits_h_
diff --git a/include/SDL3/SDL_blendmode.h b/include/SDL3/SDL_blendmode.h
index 7276c9237ec8..d84d2ba926c0 100644
--- a/include/SDL3/SDL_blendmode.h
+++ b/include/SDL3/SDL_blendmode.h
@@ -22,7 +22,7 @@
/**
* \file SDL_blendmode.h
*
- * \brief Header file declaring the SDL_BlendMode enumeration
+ * Header file declaring the SDL_BlendMode enumeration
*/
#ifndef SDL_blendmode_h_
@@ -35,7 +35,7 @@ extern "C" {
#endif
/**
- * \brief The blend mode used in SDL_RenderTexture() and drawing operations.
+ * The blend mode used in SDL_RenderTexture() and drawing operations.
*/
typedef enum
{
@@ -60,7 +60,7 @@ typedef enum
} SDL_BlendMode;
/**
- * \brief The blend operation used when combining source and destination pixel components
+ * The blend operation used when combining source and destination pixel components
*/
typedef enum
{
@@ -72,7 +72,7 @@ typedef enum
} SDL_BlendOperation;
/**
- * \brief The normalized factor used to multiply pixel components
+ * The normalized factor used to multiply pixel components
*/
typedef enum
{
diff --git a/include/SDL3/SDL_clipboard.h b/include/SDL3/SDL_clipboard.h
index e5979646ea26..5f05034bfaee 100644
--- a/include/SDL3/SDL_clipboard.h
+++ b/include/SDL3/SDL_clipboard.h
@@ -22,7 +22,7 @@
/**
* \file SDL_clipboard.h
*
- * \brief Include file for SDL clipboard handling
+ * Include file for SDL clipboard handling
*/
#ifndef SDL_clipboard_h_
diff --git a/include/SDL3/SDL_copying.h b/include/SDL3/SDL_copying.h
index 4b9c1dea9492..4fd0ca11f2b0 100644
--- a/include/SDL3/SDL_copying.h
+++ b/include/SDL3/SDL_copying.h
@@ -22,5 +22,5 @@
/**
* \file SDL_copying.h
*
- * \brief Header file containing SDL's license.
+ * Header file containing SDL's license.
*/
diff --git a/include/SDL3/SDL_cpuinfo.h b/include/SDL3/SDL_cpuinfo.h
index 50b889f6d557..0813c4d283d0 100644
--- a/include/SDL3/SDL_cpuinfo.h
+++ b/include/SDL3/SDL_cpuinfo.h
@@ -22,7 +22,7 @@
/**
* \file SDL_cpuinfo.h
*
- * \brief CPU feature detection for SDL.
+ * CPU feature detection for SDL.
*/
#ifndef SDL_cpuinfo_h_
diff --git a/include/SDL3/SDL_egl.h b/include/SDL3/SDL_egl.h
index d9c5d679102e..1053b4c31448 100644
--- a/include/SDL3/SDL_egl.h
+++ b/include/SDL3/SDL_egl.h
@@ -22,7 +22,7 @@
/**
* \file SDL_egl.h
*
- * \brief This is a simple file to encapsulate the EGL API headers.
+ * This is a simple file to encapsulate the EGL API headers.
*/
#if !defined(_MSC_VER) && !defined(__ANDROID__) && !defined(SDL_USE_BUILTIN_OPENGL_DEFINITIONS)
diff --git a/include/SDL3/SDL_endian.h b/include/SDL3/SDL_endian.h
index b77580df3abc..d670265f1cc3 100644
--- a/include/SDL3/SDL_endian.h
+++ b/include/SDL3/SDL_endian.h
@@ -22,7 +22,7 @@
/**
* \file SDL_endian.h
*
- * \brief Functions for reading and writing endian-specific values
+ * Functions for reading and writing endian-specific values
*/
#ifndef SDL_endian_h_
diff --git a/include/SDL3/SDL_events.h b/include/SDL3/SDL_events.h
index 4c6b6efdc172..ee4e43d9626d 100644
--- a/include/SDL3/SDL_events.h
+++ b/include/SDL3/SDL_events.h
@@ -210,7 +210,7 @@ typedef enum
} SDL_EventType;
/**
- * \brief Fields shared by every event
+ * Fields shared by every event
*/
typedef struct SDL_CommonEvent
{
@@ -219,7 +219,7 @@ typedef struct SDL_CommonEvent
} SDL_CommonEvent;
/**
- * \brief Display state change event data (event.display.*)
+ * Display state change event data (event.display.*)
*/
typedef struct SDL_DisplayEvent
{
@@ -230,7 +230,7 @@ typedef struct SDL_DisplayEvent
} SDL_DisplayEvent;
/**
- * \brief Window state change event data (event.window.*)
+ * Window state change event data (event.window.*)
*/
typedef struct SDL_WindowEvent
{
@@ -242,7 +242,7 @@ typedef struct SDL_WindowEvent
} SDL_WindowEvent;
/**
- * \brief Keyboard button event structure (event.key.*)
+ * Keyboard button event structure (event.key.*)
*/
typedef struct SDL_KeyboardEvent
{
@@ -258,7 +258,7 @@ typedef struct SDL_KeyboardEvent
#define SDL_TEXTEDITINGEVENT_TEXT_SIZE 64
/**
- * \brief Keyboard text editing event structure (event.edit.*)
+ * Keyboard text editing event structure (event.edit.*)
*
* The `text` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
@@ -275,7 +275,7 @@ typedef struct SDL_TextEditingEvent
#define SDL_TEXTINPUTEVENT_TEXT_SIZE 64
/**
- * \brief Keyboard text input event structure (event.text.*)
+ * Keyboard text input event structure (event.text.*)
*
* The `text` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
@@ -289,7 +289,7 @@ typedef struct SDL_TextInputEvent
} SDL_TextInputEvent;
/**
- * \brief Mouse motion event structure (event.motion.*)
+ * Mouse motion event structure (event.motion.*)
*/
typedef struct SDL_MouseMotionEvent
{
@@ -305,7 +305,7 @@ typedef struct SDL_MouseMotionEvent
} SDL_MouseMotionEvent;
/**
- * \brief Mouse button event structure (event.button.*)
+ * Mouse button event structure (event.button.*)
*/
typedef struct SDL_MouseButtonEvent
{
@@ -322,7 +322,7 @@ typedef struct SDL_MouseButtonEvent
} SDL_MouseButtonEvent;
/**
- * \brief Mouse wheel event structure (event.wheel.*)
+ * Mouse wheel event structure (event.wheel.*)
*/
typedef struct SDL_MouseWheelEvent
{
@@ -338,7 +338,7 @@ typedef struct SDL_MouseWheelEvent
} SDL_MouseWheelEvent;
/**
- * \brief Joystick axis motion event structure (event.jaxis.*)
+ * Joystick axis motion event structure (event.jaxis.*)
*/
typedef struct SDL_JoyAxisEvent
{
@@ -354,7 +354,7 @@ typedef struct SDL_JoyAxisEvent
} SDL_JoyAxisEvent;
/**
- * \brief Joystick hat position change event structure (event.jhat.*)
+ * Joystick hat position change event structure (event.jhat.*)
*/
typedef struct SDL_JoyHatEvent
{
@@ -374,7 +374,7 @@ typedef struct SDL_JoyHatEvent
} SDL_JoyHatEvent;
/**
- * \brief Joystick button event structure (event.jbutton.*)
+ * Joystick button event structure (event.jbutton.*)
*/
typedef struct SDL_JoyButtonEvent
{
@@ -388,7 +388,7 @@ typedef struct SDL_JoyButtonEvent
} SDL_JoyButtonEvent;
/**
- * \brief Joystick device event structure (event.jdevice.*)
+ * Joystick device event structure (event.jdevice.*)
*/
typedef struct SDL_JoyDeviceEvent
{
@@ -398,7 +398,7 @@ typedef struct SDL_JoyDeviceEvent
} SDL_JoyDeviceEvent;
/**
- * \brief Joysick battery level change event structure (event.jbattery.*)
+ * Joysick battery level change event structure (event.jbattery.*)
*/
typedef struct SDL_JoyBatteryEvent
{
@@ -409,7 +409,7 @@ typedef struct SDL_JoyBatteryEvent
} SDL_JoyBatteryEvent;
/**
- * \brief Gamepad axis motion event structure (event.gaxis.*)
+ * Gamepad axis motion event structure (event.gaxis.*)
*/
typedef struct SDL_GamepadAxisEvent
{
@@ -426,7 +426,7 @@ typedef struct SDL_GamepadAxisEvent
/**
- * \brief Gamepad button event structure (event.gbutton.*)
+ * Gamepad button event structure (event.gbutton.*)
*/
typedef struct SDL_GamepadButtonEvent
{
@@ -441,7 +441,7 @@ typedef struct SDL_GamepadButtonEvent
/**
- * \brief Gamepad device event structure (event.gdevice.*)
+ * Gamepad device event structure (event.gdevice.*)
*/
typedef struct SDL_GamepadDeviceEvent
{
@@ -451,7 +451,7 @@ typedef struct SDL_GamepadDeviceEvent
} SDL_GamepadDeviceEvent;
/**
- * \brief Gamepad touchpad event structure (event.gtouchpad.*)
+ * Gamepad touchpad event structure (event.gtouchpad.*)
*/
typedef struct SDL_GamepadTouchpadEvent
{
@@ -466,7 +466,7 @@ typedef struct SDL_GamepadTouchpadEvent
} SDL_GamepadTouchpadEvent;
/**
- * \brief Gamepad sensor event structure (event.gsensor.*)
+ * Gamepad sensor event structure (event.gsensor.*)
*/
typedef struct SDL_GamepadSensorEvent
{
@@ -479,7 +479,7 @@ typedef struct SDL_GamepadSensorEvent
} SDL_GamepadSensorEvent;
/**
- * \brief Audio device event structure (event.adevice.*)
+ * Audio device event structure (event.adevice.*)
*/
typedef struct SDL_AudioDeviceEvent
{
@@ -494,7 +494,7 @@ typedef struct SDL_AudioDeviceEvent
/**
- * \brief Touch finger event structure (event.tfinger.*)
+ * Touch finger event structure (event.tfinger.*)
*/
typedef struct SDL_TouchFingerEvent
{
@@ -513,7 +513,7 @@ typedef struct SDL_TouchFingerEvent
#define SDL_DROPEVENT_DATA_SIZE 64
/**
- * \brief An event used to drop text or request a file open by the system (event.drop.*)
+ * An event used to drop text or request a file open by the system (event.drop.*)
*
* The `data` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
@@ -530,7 +530,7 @@ typedef struct SDL_DropEvent
} SDL_DropEvent;
/**
- * \brief An event triggered when the clipboard contents have changed (event.clipboard.*)
+ * An event triggered when the clipboard contents have changed (event.clipboard.*)
*/
typedef struct SDL_ClipboardEvent
{
@@ -539,7 +539,7 @@ typedef struct SDL_ClipboardEvent
} SDL_ClipboardEvent;
/**
- * \brief Sensor event structure (event.sensor.*)
+ * Sensor event structure (event.sensor.*)
*/
typedef struct SDL_SensorEvent
{
@@ -551,7 +551,7 @@ typedef struct SDL_SensorEvent
} SDL_SensorEvent;
/**
- * \brief The "quit requested" event
+ * The "quit requested" event
*/
typedef struct SDL_QuitEvent
{
@@ -560,7 +560,7 @@ typedef struct SDL_QuitEvent
} SDL_QuitEvent;
/**
- * \brief OS Specific event
+ * OS Specific event
*/
typedef struct SDL_OSEvent
{
@@ -569,7 +569,7 @@ typedef struct SDL_OSEvent
} SDL_OSEvent;
/**
- * \brief A user-defined event type (event.user.*)
+ * A user-defined event type (event.user.*)
*/
typedef struct SDL_UserEvent
{
@@ -586,13 +586,15 @@ struct SDL_SysWMmsg;
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
/**
- * \brief A video driver dependent system event (event.syswm.*)
- * This event is disabled by default, you can enable it with SDL_SetEventEnabled()
+ * A video driver dependent system event (event.syswm.*)
*
- * The `msg` is owned by SDL and should be copied if the application
- * wants to hold onto it beyond the scope of handling this event.
+ * This event is disabled by default, you can enable it with
+ * SDL_SetEventEnabled()
+ *
+ * The `msg` is owned by SDL and should be copied if the application
+ * wants to hold onto it beyond the scope of handling this event.
*
- * \note If you want to use this event, you should include SDL_syswm.h.
+ * \note If you want to use this event, you should include SDL_syswm.h.
*/
typedef struct SDL_SysWMEvent
{
@@ -602,7 +604,7 @@ typedef struct SDL_SysWMEvent
} SDL_SysWMEvent;
/**
- * \brief General event structure
+ * General event structure
*/
typedef union SDL_Event
{
diff --git a/include/SDL3/SDL_filesystem.h b/include/SDL3/SDL_filesystem.h
index ae8139c1bc67..996030662ea0 100644
--- a/include/SDL3/SDL_filesystem.h
+++ b/include/SDL3/SDL_filesystem.h
@@ -22,7 +22,7 @@
/**
* \file SDL_filesystem.h
*
- * \brief Include file for filesystem SDL API functions
+ * Include file for filesystem SDL API functions
*/
#ifndef SDL_filesystem_h_
diff --git a/include/SDL3/SDL_gamepad.h b/include/SDL3/SDL_gamepad.h
index 5f409432d968..04b27671805d 100644
--- a/include/SDL3/SDL_gamepad.h
+++ b/include/SDL3/SDL_gamepad.h
@@ -22,7 +22,7 @@
/**
* \file SDL_gamepad.h
*
- * \brief Include file for SDL gamepad event handling
+ * Include file for SDL gamepad event handling
*/
#ifndef SDL_gamepad_h_
diff --git a/include/SDL3/SDL_guid.h b/include/SDL3/SDL_guid.h
index fbd70143fd07..11f1ffa6c27c 100644
--- a/include/SDL3/SDL_guid.h
+++ b/include/SDL3/SDL_guid.h
@@ -22,7 +22,7 @@
/**
* \file SDL_guid.h
*
- * \brief Include file for handling ::SDL_GUID values.
+ * Include file for handling ::SDL_GUID values.
*/
#ifndef SDL_guid_h_
diff --git a/include/SDL3/SDL_haptic.h b/include/SDL3/SDL_haptic.h
index 7dbd3916a308..1b336ffb5335 100644
--- a/include/SDL3/SDL_haptic.h
+++ b/include/SDL3/SDL_haptic.h
@@ -22,8 +22,7 @@
/**
* \file SDL_haptic.h
*
- * \brief The SDL haptic subsystem allows you to control haptic (force feedback)
- * devices.
+ * The SDL haptic subsystem manages haptic (force feedback) devices.
*
* The basic usage is as follows:
* - Initialize the subsystem (::SDL_INIT_HAPTIC).
@@ -131,7 +130,7 @@ extern "C" {
/**
* \typedef SDL_Haptic
*
- * \brief The haptic structure used to identify an SDL haptic.
+ * The haptic structure used to identify an SDL haptic.
*
* \sa SDL_HapticOpen
* \sa SDL_HapticOpenFromJoystick
@@ -154,7 +153,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/* @{ */
/**
- * \brief Constant effect supported.
+ * Constant effect supported.
*
* Constant haptic effect.
*
@@ -163,7 +162,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_CONSTANT (1u<<0)
/**
- * \brief Sine wave effect supported.
+ * Sine wave effect supported.
*
* Periodic haptic effect that simulates sine waves.
*
@@ -172,7 +171,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_SINE (1u<<1)
/**
- * \brief Left/Right effect supported.
+ * Left/Right effect supported.
*
* Haptic effect for direct control over high/low frequency motors.
*
@@ -186,7 +185,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/* #define SDL_HAPTIC_SQUARE (1<<2) */
/**
- * \brief Triangle wave effect supported.
+ * Triangle wave effect supported.
*
* Periodic haptic effect that simulates triangular waves.
*
@@ -195,7 +194,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_TRIANGLE (1u<<3)
/**
- * \brief Sawtoothup wave effect supported.
+ * Sawtoothup wave effect supported.
*
* Periodic haptic effect that simulates saw tooth up waves.
*
@@ -204,7 +203,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_SAWTOOTHUP (1u<<4)
/**
- * \brief Sawtoothdown wave effect supported.
+ * Sawtoothdown wave effect supported.
*
* Periodic haptic effect that simulates saw tooth down waves.
*
@@ -213,7 +212,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_SAWTOOTHDOWN (1u<<5)
/**
- * \brief Ramp effect supported.
+ * Ramp effect supported.
*
* Ramp haptic effect.
*
@@ -222,7 +221,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_RAMP (1u<<6)
/**
- * \brief Spring effect supported - uses axes position.
+ * Spring effect supported - uses axes position.
*
* Condition haptic effect that simulates a spring. Effect is based on the
* axes position.
@@ -232,7 +231,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_SPRING (1u<<7)
/**
- * \brief Damper effect supported - uses axes velocity.
+ * Damper effect supported - uses axes velocity.
*
* Condition haptic effect that simulates dampening. Effect is based on the
* axes velocity.
@@ -242,7 +241,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_DAMPER (1u<<8)
/**
- * \brief Inertia effect supported - uses axes acceleration.
+ * Inertia effect supported - uses axes acceleration.
*
* Condition haptic effect that simulates inertia. Effect is based on the axes
* acceleration.
@@ -252,7 +251,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_INERTIA (1u<<9)
/**
- * \brief Friction effect supported - uses axes movement.
+ * Friction effect supported - uses axes movement.
*
* Condition haptic effect that simulates friction. Effect is based on the
* axes movement.
@@ -262,7 +261,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_FRICTION (1u<<10)
/**
- * \brief Custom effect is supported.
+ * Custom effect is supported.
*
* User defined custom haptic effect.
*/
@@ -273,7 +272,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/* These last few are features the device has, not effects */
/**
- * \brief Device can set global gain.
+ * Device can set global gain.
*
* Device supports setting the global gain.
*
@@ -282,7 +281,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_GAIN (1u<<12)
/**
- * \brief Device can set autocenter.
+ * Device can set autocenter.
*
* Device supports setting autocenter.
*
@@ -291,7 +290,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_AUTOCENTER (1u<<13)
/**
- * \brief Device can be queried for effect status.
+ * Device can be queried for effect status.
*
* Device supports querying effect status.
*
@@ -300,7 +299,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_STATUS (1u<<14)
/**
- * \brief Device can be paused.
+ * Device can be paused.
*
* Devices supports being paused.
*
@@ -316,31 +315,33 @@ typedef struct SDL_Haptic SDL_Haptic;
/* @{ */
/**
- * \brief Uses polar coordinates for the direction.
+ * Uses polar coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_POLAR 0
/**
- * \brief Uses cartesian coordinates for the direction.
+ * Uses cartesian coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_CARTESIAN 1
/**
- * \brief Uses spherical coordinates for the direction.
+ * Uses spherical coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_SPHERICAL 2
/**
- * \brief Use this value to play an effect on the steering wheel axis. This
- * provides better compatibility across platforms and devices as SDL will guess
- * the correct axis.
- * \sa SDL_HapticDirection
+ * Use this value to play an effect on the steering wheel axis.
+ *
+ * This provides better compatibility across platforms and devices as SDL
+ * will guess the correct axis.
+ *
+ * \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_STEERING_AXIS 3
@@ -353,7 +354,7 @@ typedef struct SDL_Haptic SDL_Haptic;
*/
/**
- * \brief Used to play a device an infinite number of times.
+ * Used to play a device an infinite number of times.
*
* \sa SDL_HapticRunEffect
*/
@@ -361,7 +362,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/**
- * \brief Structure that represents a haptic direction.
+ * Structure that represents a haptic direction.
*
* This is the direction where the force comes from,
* instead of the direction in which the force is exerted.
@@ -464,7 +465,7 @@ typedef struct SDL_HapticDirection
/**
- * \brief A structure containing a template for a Constant effect.
+ * A structure containing a template for a Constant effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_CONSTANT effect.
*
@@ -499,7 +500,7 @@ typedef struct SDL_HapticConstant
} SDL_HapticConstant;
/**
- * \brief A structure containing a template for a Periodic effect.
+ * A structure containing a template for a Periodic effect.
*
* The struct handles the following effects:
* - ::SDL_HAPTIC_SINE
@@ -585,7 +586,7 @@ typedef struct SDL_HapticPeriodic
} SDL_HapticPeriodic;
/**
- * \brief A structure containing a template for a Condition effect.
+ * A structure containing a template for a Condition effect.
*
* The struct handles the following effects:
* - ::SDL_HAPTIC_SPRING: Effect based on axes position.
@@ -633,7 +634,7 @@ typedef struct SDL_HapticCondition
} SDL_HapticCondition;
/**
- * \brief A structure containing a template for a Ramp effect.
+ * A structure containing a template for a Ramp effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_RAMP effect.
*
@@ -671,7 +672,7 @@ typedef struct SDL_HapticRamp
} SDL_HapticRamp;
/**
- * \brief A structure containing a template for a Left/Right effect.
+ * A structure containing a template for a Left/Right effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_LEFTRIGHT effect.
*
@@ -696,7 +697,7 @@ typedef struct SDL_HapticLeftRight
} SDL_HapticLeftRight;
/**
- * \brief A structure containing a template for the ::SDL_HAPTIC_CUSTOM effect.
+ * A structure containing a template for the ::SDL_HAPTIC_CUSTOM effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_CUSTOM effect.
*
@@ -738,7 +739,7 @@ typedef struct SDL_HapticCustom
} SDL_HapticCustom;
/**
- * \brief The generic template for any haptic effect.
+ * The generic template for any haptic effect.
*
* All values max at 32767 (0x7FFF). Signed values also can be negative.
* Time values unless specified otherwise are in milliseconds.
diff --git a/include/SDL3/SDL_hidapi.h b/include/SDL3/SDL_hidapi.h
index 1d7b222456a3..3a1bbace0f53 100644
--- a/include/SDL3/SDL_hidapi.h
+++ b/include/SDL3/SDL_hidapi.h
@@ -22,7 +22,7 @@
/**
* \file SDL_hidapi.h
*
- * \brief Header file for SDL HIDAPI functions.
+ * Header file for SDL HIDAPI functions.
*
* This is an adaptation of the original HIDAPI interface by Alan Ott,
* and includes source code licensed under the following BSD license:
@@ -71,13 +71,13 @@ extern "C" {
#endif
/**
- * \brief A handle representing an open HID device
+ * A handle representing an open HID device
*/
struct SDL_hid_device_;
typedef struct SDL_hid_device_ SDL_hid_device; /**< opaque hidapi structure */
/**
- * \brief HID underlying bus types.
+ * HID underlying bus types.
*/
typedef enum {
/** Unknown bus type */
@@ -109,7 +109,7 @@ typedef enum {
/** hidapi info structure */
/**
- * \brief Information about a connected HID device
+ * Information about a connected HID device
*/
typedef struct SDL_hid_device_info
{
diff --git a/include/SDL3/SDL_hints.h b/include/SDL3/SDL_hints.h
index fd746553ce2c..a4933ac77bba 100644
--- a/include/SDL3/SDL_hints.h
+++ b/include/SDL3/SDL_hints.h
@@ -22,7 +22,7 @@
/**
* \file SDL_hints.h
*
- * \brief Official documentation for SDL configuration variables
+ * Official documentation for SDL configuration variables
*
* This file contains functions to set and get configuration hints,
* as well as listing each of them alphabetically.
@@ -48,17 +48,16 @@ extern "C" {
#endif
/**
- * \brief A variable controlling whether the Android / iOS built-in
- * accelerometer should be listed as a joystick device.
+ * Set if Android/iOS accelerometers should be listed as joystick devices.
*
- * This variable can be set to the following values:
+ * This variable can be set to the following values:
* "0" - The accelerometer is not listed as a joystick
* "1" - The accelerometer is available as a 3 axis joystick (the default).
*/
#define SDL_HINT_ACCELEROMETER_AS_JOYSTICK "SDL_ACCELEROMETER_AS_JOYSTICK"
/**
- * \brief Specify the behavior of Alt+Tab while the keyboard is grabbed.
+ * Specify the behavior of Alt+Tab whi
(Patch may be truncated, please check the link at the top of this post.)