Procházet zdrojové kódy

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.
Ryan C. Gordon před 1 rokem
rodič
revize
c53843a961
100 změnil soubory, kde provedl 645 přidání a 643 odebrání
  1. 1 1
      include/SDL3/SDL_assert.h
  2. 6 5
      include/SDL3/SDL_atomic.h
  3. 2 2
      include/SDL3/SDL_audio.h
  4. 1 1
      include/SDL3/SDL_bits.h
  5. 4 4
      include/SDL3/SDL_blendmode.h
  6. 1 1
      include/SDL3/SDL_clipboard.h
  7. 1 1
      include/SDL3/SDL_copying.h
  8. 1 1
      include/SDL3/SDL_cpuinfo.h
  9. 1 1
      include/SDL3/SDL_egl.h
  10. 1 1
      include/SDL3/SDL_endian.h
  11. 35 33
      include/SDL3/SDL_events.h
  12. 1 1
      include/SDL3/SDL_filesystem.h
  13. 1 1
      include/SDL3/SDL_gamepad.h
  14. 1 1
      include/SDL3/SDL_guid.h
  15. 36 35
      include/SDL3/SDL_haptic.h
  16. 4 4
      include/SDL3/SDL_hidapi.h
  17. 178 180
      include/SDL3/SDL_hints.h
  18. 2 2
      include/SDL3/SDL_init.h
  19. 1 1
      include/SDL3/SDL_intrin.h
  20. 2 2
      include/SDL3/SDL_joystick.h
  21. 2 2
      include/SDL3/SDL_keyboard.h
  22. 3 3
      include/SDL3/SDL_keycode.h
  23. 1 1
      include/SDL3/SDL_loadso.h
  24. 1 1
      include/SDL3/SDL_locale.h
  25. 4 4
      include/SDL3/SDL_log.h
  26. 1 1
      include/SDL3/SDL_main.h
  27. 2 2
      include/SDL3/SDL_metal.h
  28. 1 1
      include/SDL3/SDL_misc.h
  29. 3 3
      include/SDL3/SDL_mouse.h
  30. 1 1
      include/SDL3/SDL_mutex.h
  31. 1 1
      include/SDL3/SDL_oldnames.h
  32. 1 1
      include/SDL3/SDL_opengl.h
  33. 1 1
      include/SDL3/SDL_opengles.h
  34. 1 1
      include/SDL3/SDL_opengles2.h
  35. 1 1
      include/SDL3/SDL_pixels.h
  36. 1 1
      include/SDL3/SDL_platform.h
  37. 1 1
      include/SDL3/SDL_platform_defines.h
  38. 1 1
      include/SDL3/SDL_power.h
  39. 1 1
      include/SDL3/SDL_properties.h
  40. 1 1
      include/SDL3/SDL_quit.h
  41. 1 1
      include/SDL3/SDL_rect.h
  42. 1 1
      include/SDL3/SDL_render.h
  43. 1 1
      include/SDL3/SDL_revision.h
  44. 2 2
      include/SDL3/SDL_scancode.h
  45. 2 2
      include/SDL3/SDL_sensor.h
  46. 11 11
      include/SDL3/SDL_shape.h
  47. 10 10
      include/SDL3/SDL_stdinc.h
  48. 4 4
      include/SDL3/SDL_surface.h
  49. 11 11
      include/SDL3/SDL_system.h
  50. 2 2
      include/SDL3/SDL_syswm.h
  51. 1 1
      include/SDL3/SDL_test.h
  52. 9 9
      include/SDL3/SDL_test_assert.h
  53. 9 9
      include/SDL3/SDL_test_common.h
  54. 3 3
      include/SDL3/SDL_test_compare.h
  55. 4 4
      include/SDL3/SDL_test_crc32.h
  56. 11 11
      include/SDL3/SDL_test_font.h
  57. 1 1
      include/SDL3/SDL_test_fuzzer.h
  58. 3 3
      include/SDL3/SDL_test_harness.h
  59. 3 3
      include/SDL3/SDL_test_log.h
  60. 4 4
      include/SDL3/SDL_test_md5.h
  61. 4 4
      include/SDL3/SDL_test_memory.h
  62. 4 4
      include/SDL3/SDL_test_random.h
  63. 1 1
      include/SDL3/SDL_thread.h
  64. 1 1
      include/SDL3/SDL_timer.h
  65. 1 1
      include/SDL3/SDL_touch.h
  66. 1 1
      include/SDL3/SDL_version.h
  67. 13 13
      include/SDL3/SDL_video.h
  68. 1 1
      include/SDL3/SDL_vulkan.h
  69. 1 1
      include/build_config/SDL_build_config.h
  70. 1 1
      include/build_config/SDL_build_config.h.cmake
  71. 1 1
      include/build_config/SDL_revision.h.cmake
  72. 1 1
      src/core/linux/SDL_udev.h
  73. 1 1
      src/hidapi/doxygen/Doxyfile
  74. 8 8
      src/render/software/SDL_rotate.c
  75. 2 2
      src/test/SDL_test_assert.c
  76. 1 1
      src/test/SDL_test_font.c
  77. 5 5
      src/test/SDL_test_harness.c
  78. 18 18
      test/testautomation_audio.c
  79. 3 3
      test/testautomation_clipboard.c
  80. 3 3
      test/testautomation_events.c
  81. 2 2
      test/testautomation_guid.c
  82. 2 2
      test/testautomation_hints.c
  83. 11 11
      test/testautomation_images.c
  84. 4 4
      test/testautomation_intrinsics.c
  85. 1 1
      test/testautomation_joystick.c
  86. 14 14
      test/testautomation_keyboard.c
  87. 1 1
      test/testautomation_main.c
  88. 5 5
      test/testautomation_math.c
  89. 12 12
      test/testautomation_mouse.c
  90. 3 3
      test/testautomation_pixels.c
  91. 12 12
      test/testautomation_platform.c
  92. 3 3
      test/testautomation_properties.c
  93. 39 39
      test/testautomation_rect.c
  94. 18 18
      test/testautomation_render.c
  95. 8 8
      test/testautomation_rwops.c
  96. 15 15
      test/testautomation_sdltest.c
  97. 7 7
      test/testautomation_stdlib.c
  98. 4 4
      test/testautomation_subsystems.c
  99. 10 10
      test/testautomation_surface.c
  100. 1 1
      test/testautomation_syswm.c

+ 1 - 1
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_

+ 6 - 5
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

+ 2 - 2
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).

+ 1 - 1
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_

+ 4 - 4
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
 {

+ 1 - 1
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_

+ 1 - 1
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.
  */

+ 1 - 1
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_

+ 1 - 1
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)

+ 1 - 1
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_

+ 35 - 33
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
 {

+ 1 - 1
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_

+ 1 - 1
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_

+ 1 - 1
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_

+ 36 - 35
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.

+ 4 - 4
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
 {

+ 178 - 180
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 while the keyboard is grabbed.
  *
  * By default, SDL emulates Alt+Tab functionality while the keyboard is grabbed
  * and your window is full-screen. This prevents the user from getting stuck in
@@ -72,7 +71,7 @@ extern "C" {
 #define SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED "SDL_ALLOW_ALT_TAB_WHILE_GRABBED"
 
 /**
- *  \brief If set to "0" then never set the top most bit on a SDL Window, even if the video mode expects it.
+ *  If set to "0" then never set the top most bit on a SDL Window, even if the video mode expects it.
  *      This is a debugging aid for developers and not expected to be used by end users. The default is "1"
  *
  *  This variable can be set to the following values:
@@ -82,7 +81,7 @@ extern "C" {
 #define SDL_HINT_ALLOW_TOPMOST "SDL_ALLOW_TOPMOST"
 
 /**
- * \brief A variable to control whether the event loop will block itself when the app is paused.
+ * A variable to control whether the event loop will block itself when the app is paused.
  *
  * The variable can be set to the following values:
  *   "0"       - Non blocking.
@@ -93,7 +92,7 @@ extern "C" {
 #define SDL_HINT_ANDROID_BLOCK_ON_PAUSE "SDL_ANDROID_BLOCK_ON_PAUSE"
 
 /**
- * \brief A variable to control whether SDL will pause audio in background
+ * A variable to control whether SDL will pause audio in background
  *        (Requires SDL_ANDROID_BLOCK_ON_PAUSE as "Non blocking")
  *
  * The variable can be set to the following values:
@@ -105,7 +104,7 @@ extern "C" {
 #define SDL_HINT_ANDROID_BLOCK_ON_PAUSE_PAUSEAUDIO "SDL_ANDROID_BLOCK_ON_PAUSE_PAUSEAUDIO"
 
 /**
- * \brief A variable to control whether we trap the Android back button to handle it manually.
+ * A variable to control whether we trap the Android back button to handle it manually.
  *        This is necessary for the right mouse button to work on some Android devices, or
  *        to be able to trap the back button for use in your code reliably.  If set to true,
  *        the back button will show up as an SDL_EVENT_KEY_DOWN / SDL_EVENT_KEY_UP pair with a keycode of
@@ -122,7 +121,7 @@ extern "C" {
 #define SDL_HINT_ANDROID_TRAP_BACK_BUTTON "SDL_ANDROID_TRAP_BACK_BUTTON"
 
 /**
- * \brief A variable to control whether SDL activity is allowed to be re-created.
+ * A variable to control whether SDL activity is allowed to be re-created.
  *        If so, java static datas and static datas from native libraries remain with their current values.
  *        When not allowed, the activity terminates with exit(0) to be fully re-initialized afterward.
  *
@@ -135,7 +134,7 @@ extern "C" {
 #define SDL_HINT_ANDROID_ALLOW_RECREATE_ACTIVITY "SDL_ANDROID_ALLOW_RECREATE_ACTIVITY"
 
 /**
- *  \brief  A variable setting the app ID string.
+ *  A variable setting the app ID string.
  *          This string is used by desktop compositors to identify and group windows
  *          together, as well as match applications with associated desktop settings
  *          and icons.
@@ -182,7 +181,7 @@ extern "C" {
 #define SDL_HINT_APP_ID      "SDL_APP_ID"
 
 /**
- *  \brief Specify an application name.
+ *  Specify an application name.
  *
  * This hint lets you specify the application name sent to the OS when
  * required. For example, this will often appear in volume control applets for
@@ -202,7 +201,7 @@ extern "C" {
 #define SDL_HINT_APP_NAME "SDL_APP_NAME"
 
 /**
- *  \brief  A variable controlling whether controllers used with the Apple TV
+ *  A variable controlling whether controllers used with the Apple TV
  *  generate UI events.
  *
  * When UI events are generated by controller input, the app will be
@@ -220,7 +219,7 @@ extern "C" {
 #define SDL_HINT_APPLE_TV_CONTROLLER_UI_EVENTS "SDL_APPLE_TV_CONTROLLER_UI_EVENTS"
 
 /**
- * \brief  A variable controlling whether the Apple TV remote's joystick axes
+ * A variable controlling whether the Apple TV remote's joystick axes
  *         will automatically match the rotation of the remote.
  *
  *  This variable can be set to the following values:
@@ -230,7 +229,7 @@ extern "C" {
 #define SDL_HINT_APPLE_TV_REMOTE_ALLOW_ROTATION "SDL_APPLE_TV_REMOTE_ALLOW_ROTATION"
 
 /**
- *  \brief  A variable controlling the audio category on iOS and macOS
+ *  A variable controlling the audio category on iOS and macOS
  *
  *  This variable can be set to the following values:
  *
@@ -243,7 +242,7 @@ extern "C" {
 #define SDL_HINT_AUDIO_CATEGORY   "SDL_AUDIO_CATEGORY"
 
 /**
- *  \brief Specify an application name for an audio device.
+ *  Specify an application name for an audio device.
  *
  * Some audio backends (such as PulseAudio) allow you to describe your audio
  * stream. Among other things, this description might show up in a system
@@ -264,7 +263,7 @@ extern "C" {
 #define SDL_HINT_AUDIO_DEVICE_APP_NAME "SDL_AUDIO_DEVICE_APP_NAME"
 
 /**
- *  \brief Specify an application name for an audio device.
+ *  Specify an application name for an audio device.
  *
  * Some audio backends (such as PulseAudio) allow you to describe your audio
  * stream. Among other things, this description might show up in a system
@@ -285,7 +284,7 @@ extern "C" {
 #define SDL_HINT_AUDIO_DEVICE_STREAM_NAME "SDL_AUDIO_DEVICE_STREAM_NAME"
 
 /**
- *  \brief Specify an application role for an audio device.
+ *  Specify an application role for an audio device.
  *
  * Some audio backends (such as Pipewire) allow you to describe the role of
  * your audio stream. Among other things, this description might show up in
@@ -305,7 +304,7 @@ extern "C" {
 #define SDL_HINT_AUDIO_DEVICE_STREAM_ROLE "SDL_AUDIO_DEVICE_STREAM_ROLE"
 
 /**
- *  \brief  A variable controlling whether SDL updates joystick state when getting input events
+ *  A variable controlling whether SDL updates joystick state when getting input events
  *
  *  This variable can be set to the following values:
  *
@@ -317,7 +316,7 @@ extern "C" {
 #define SDL_HINT_AUTO_UPDATE_JOYSTICKS  "SDL_AUTO_UPDATE_JOYSTICKS"
 
 /**
- *  \brief  A variable controlling whether SDL updates sensor state when getting input events
+ *  A variable controlling whether SDL updates sensor state when getting input events
  *
  *  This variable can be set to the following values:
  *
@@ -329,7 +328,7 @@ extern "C" {
 #define SDL_HINT_AUTO_UPDATE_SENSORS    "SDL_AUTO_UPDATE_SENSORS"
 
 /**
- *  \brief Prevent SDL from using version 4 of the bitmap header when saving BMPs.
+ *  Prevent SDL from using version 4 of the bitmap header when saving BMPs.
  *
  * The bitmap header version 4 is required for proper alpha channel support and
  * SDL will use it when required. Should this not be desired, this hint can
@@ -348,7 +347,7 @@ extern "C" {
 #define SDL_HINT_BMP_SAVE_LEGACY_FORMAT "SDL_BMP_SAVE_LEGACY_FORMAT"
 
 /**
- *  \brief Override for SDL_GetDisplayUsableBounds()
+ *  Override for SDL_GetDisplayUsableBounds()
  *
  *  If set, this hint will override the expected results for
  *  SDL_GetDisplayUsableBounds() for display index 0. Generally you don't want
@@ -362,7 +361,7 @@ extern "C" {
 #define SDL_HINT_DISPLAY_USABLE_BOUNDS "SDL_DISPLAY_USABLE_BOUNDS"
 
 /**
- *  \brief Disable giving back control to the browser automatically
+ *  Disable giving back control to the browser automatically
  *  when running with asyncify
  *
  * With -s ASYNCIFY, SDL calls emscripten_sleep during operations
@@ -377,7 +376,7 @@ extern "C" {
 #define SDL_HINT_EMSCRIPTEN_ASYNCIFY   "SDL_EMSCRIPTEN_ASYNCIFY"
 
 /**
- *  \brief Specify the CSS selector used for the "default" window/canvas
+ *  Specify the CSS selector used for the "default" window/canvas
  *
  * This hint only applies to the emscripten platform
  *
@@ -386,7 +385,7 @@ extern "C" {
 #define SDL_HINT_EMSCRIPTEN_CANVAS_SELECTOR "SDL_EMSCRIPTEN_CANVAS_SELECTOR"
 
 /**
- *  \brief override the binding element for keyboard inputs for Emscripten builds
+ *  override the binding element for keyboard inputs for Emscripten builds
  *
  * This hint only applies to the emscripten platform
  *
@@ -400,7 +399,7 @@ extern "C" {
 #define SDL_HINT_EMSCRIPTEN_KEYBOARD_ELEMENT   "SDL_EMSCRIPTEN_KEYBOARD_ELEMENT"
 
 /**
- *  \brief  A variable that controls whether the on-screen keyboard should be shown when text input is active
+ *  A variable that controls whether the on-screen keyboard should be shown when text input is active
  *
  *  The variable can be set to the following values:
  *    "0"       - Do not show the on-screen keyboard
@@ -411,7 +410,7 @@ extern "C" {
 #define SDL_HINT_ENABLE_SCREEN_KEYBOARD "SDL_ENABLE_SCREEN_KEYBOARD"
 
 /**
- *  \brief  A variable controlling verbosity of the logging of SDL events pushed onto the internal queue.
+ *  A variable controlling verbosity of the logging of SDL events pushed onto the internal queue.
  *
  *  This variable can be set to the following values, from least to most verbose:
  *
@@ -433,7 +432,7 @@ extern "C" {
 #define SDL_HINT_EVENT_LOGGING   "SDL_EVENT_LOGGING"
 
 /**
- *  \brief  A variable controlling whether raising the window should be done more forcefully
+ *  A variable controlling whether raising the window should be done more forcefully
  *
  *  This variable can be set to the following values:
  *    "0"       - No forcing (the default)
@@ -446,7 +445,7 @@ extern "C" {
 #define SDL_HINT_FORCE_RAISEWINDOW    "SDL_HINT_FORCE_RAISEWINDOW"
 
 /**
-*  \brief  A variable controlling whether the window is activated when the SDL_RaiseWindow function is called
+*  A variable controlling whether the window is activated when the SDL_RaiseWindow function is called
 *
 *  This variable can be set to the following values:
 *    "0"       - The window is not activated when the SDL_RaiseWindow function is called
@@ -458,7 +457,7 @@ extern "C" {
 #define SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED    "SDL_WINDOW_ACTIVATE_WHEN_RAISED"
 
 /**
- *  \brief  A variable controlling how 3D acceleration is used to accelerate the SDL screen surface.
+ *  A variable controlling how 3D acceleration is used to accelerate the SDL screen surface.
  *
  *  SDL can try to accelerate the SDL screen surface by using streaming
  *  textures with a 3D rendering engine.  This variable controls whether and
@@ -475,7 +474,7 @@ extern "C" {
 #define SDL_HINT_FRAMEBUFFER_ACCELERATION   "SDL_FRAMEBUFFER_ACCELERATION"
 
 /**
- *  \brief  A variable that lets you manually hint extra gamecontroller db entries.
+ *  A variable that lets you manually hint extra gamecontroller db entries.
  *
  *  The variable should be newline delimited rows of gamecontroller config data, see SDL_gamepad.h
  *
@@ -485,7 +484,7 @@ extern "C" {
 #define SDL_HINT_GAMECONTROLLERCONFIG "SDL_GAMECONTROLLERCONFIG"
 
 /**
- *  \brief  A variable that lets you provide a file with extra gamecontroller db entries.
+ *  A variable that lets you provide a file with extra gamecontroller db entries.
  *
  *  The file should contain lines of gamecontroller config data, see SDL_gamepad.h
  *
@@ -495,7 +494,7 @@ extern "C" {
 #define SDL_HINT_GAMECONTROLLERCONFIG_FILE "SDL_GAMECONTROLLERCONFIG_FILE"
 
 /**
- *  \brief  A variable that overrides the automatic controller type detection
+ *  A variable that overrides the automatic controller type detection
  *
  *  The variable should be comma separated entries, in the form: VID/PID=type
  *
@@ -514,7 +513,7 @@ extern "C" {
 #define SDL_HINT_GAMECONTROLLERTYPE "SDL_GAMECONTROLLERTYPE"
 
 /**
- *  \brief  A variable containing a list of devices to skip when scanning for game controllers.
+ *  A variable containing a list of devices to skip when scanning for game controllers.
  *
  *  The format of the string is a comma separated list of USB VID/PID pairs
  *  in hexadecimal form, e.g.
@@ -527,7 +526,7 @@ extern "C" {
 #define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES "SDL_GAMECONTROLLER_IGNORE_DEVICES"
 
 /**
- *  \brief  If set, all devices will be skipped when scanning for game controllers except for the ones listed in this variable.
+ *  If set, all devices will be skipped when scanning for game controllers except for the ones listed in this variable.
  *
  *  The format of the string is a comma separated list of USB VID/PID pairs
  *  in hexadecimal form, e.g.
@@ -540,7 +539,7 @@ extern "C" {
 #define SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT "SDL_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT"
 
 /**
- *  \brief  If set, game controller face buttons report their values according to their labels instead of their positional layout.
+ *  If set, game controller face buttons report their values according to their labels instead of their positional layout.
  *
  *  For example, on Nintendo Switch controllers, normally you'd get:
  *
@@ -563,7 +562,7 @@ extern "C" {
 #define SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS "SDL_GAMECONTROLLER_USE_BUTTON_LABELS"
 
 /**
- *  \brief  Controls whether the device's built-in accelerometer and gyro should be used as sensors for gamepads.
+ *  Controls whether the device's built-in accelerometer and gyro should be used as sensors for gamepads.
  *
  *  The variable can be set to the following values:
  *    "0"       - Sensor fusion is disabled
@@ -582,7 +581,7 @@ extern "C" {
 #define SDL_HINT_GAMECONTROLLER_SENSOR_FUSION "SDL_GAMECONTROLLER_SENSOR_FUSION"
 
 /**
- *  \brief  A variable controlling whether grabbing input grabs the keyboard
+ *  A variable controlling whether grabbing input grabs the keyboard
  *
  *  This variable can be set to the following values:
  *    "0"       - Grab will affect only the mouse
@@ -593,7 +592,7 @@ extern "C" {
 #define SDL_HINT_GRAB_KEYBOARD              "SDL_GRAB_KEYBOARD"
 
 /**
- *  \brief  A variable to control whether SDL_hid_enumerate() enumerates all HID devices or only controllers.
+ *  A variable to control whether SDL_hid_enumerate() enumerates all HID devices or only controllers.
  *
  *  This variable can be set to the following values:
  *    "0"       - SDL_hid_enumerate() will enumerate all HID devices
@@ -604,7 +603,7 @@ extern "C" {
 #define SDL_HINT_HIDAPI_ENUMERATE_ONLY_CONTROLLERS "SDL_HIDAPI_ENUMERATE_ONLY_CONTROLLERS"
 
 /**
- *  \brief  A variable containing a list of devices to ignore in SDL_hid_enumerate()
+ *  A variable containing a list of devices to ignore in SDL_hid_enumerate()
  *
  *  For example, to ignore the Shanwan DS3 controller and any Valve controller, you might
  *  have the string "0x2563/0x0523,0x28de/0x0000"
@@ -612,7 +611,7 @@ extern "C" {
 #define SDL_HINT_HIDAPI_IGNORE_DEVICES "SDL_HIDAPI_IGNORE_DEVICES"
 
 /**
- * \brief A variable to control whether certain IMEs should handle text editing internally instead of sending SDL_EVENT_TEXT_EDITING events.
+ * A variable to control whether certain IMEs should handle text editing internally instead of sending SDL_EVENT_TEXT_EDITING events.
  *
  * The variable can be set to the following values:
  *   "0"       - SDL_EVENT_TEXT_EDITING events are sent, and it is the application's
@@ -624,7 +623,7 @@ extern "C" {
 #define SDL_HINT_IME_INTERNAL_EDITING "SDL_IME_INTERNAL_EDITING"
 
 /**
- * \brief A variable to control whether certain IMEs should show native UI components (such as the Candidate List) instead of suppressing them.
+ * A variable to control whether certain IMEs should show native UI components (such as the Candidate List) instead of suppressing them.
  *
  * The variable can be set to the following values:
  *   "0"       - Native UI components are not display. (default)
@@ -633,7 +632,7 @@ extern "C" {
 #define SDL_HINT_IME_SHOW_UI "SDL_IME_SHOW_UI"
 
 /**
- * \brief  A variable controlling whether the home indicator bar on iPhone X
+ * A variable controlling whether the home indicator bar on iPhone X
  *         should be hidden.
  *
  *  This variable can be set to the following values:
@@ -644,7 +643,7 @@ extern "C" {
 #define SDL_HINT_IOS_HIDE_HOME_INDICATOR "SDL_IOS_HIDE_HOME_INDICATOR"
 
 /**
- *  \brief  A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background.
+ *  A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background.
  *
  *  The variable can be set to the following values:
  *    "0"       - Disable joystick & gamecontroller input events when the
@@ -657,7 +656,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS "SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI joystick drivers should be used.
+ *  A variable controlling whether the HIDAPI joystick drivers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI drivers are not used
@@ -668,7 +667,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI "SDL_JOYSTICK_HIDAPI"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for Nintendo GameCube controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for Nintendo GameCube controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -679,7 +678,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE "SDL_JOYSTICK_HIDAPI_GAMECUBE"
 
 /**
- *  \brief  A variable controlling whether "low_frequency_rumble" and "high_frequency_rumble" is used to implement
+ *  A variable controlling whether "low_frequency_rumble" and "high_frequency_rumble" is used to implement
  *          the GameCube controller's 3 rumble modes, Stop(0), Rumble(1), and StopHard(2)
  *          this is useful for applications that need full compatibility for things like ADSR envelopes.
  *          Stop is implemented by setting "low_frequency_rumble" to "0" and "high_frequency_rumble" ">0"
@@ -694,7 +693,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_GAMECUBE_RUMBLE_BRAKE "SDL_JOYSTICK_GAMECUBE_RUMBLE_BRAKE"
 
 /**
-  *  \brief  A variable controlling whether the HIDAPI driver for Nintendo Switch Joy-Cons should be used.
+  *  A variable controlling whether the HIDAPI driver for Nintendo Switch Joy-Cons should be used.
   *
   *  This variable can be set to the following values:
   *    "0"       - HIDAPI driver is not used
@@ -705,7 +704,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_JOY_CONS "SDL_JOYSTICK_HIDAPI_JOY_CONS"
 
 /**
-  *  \brief  A variable controlling whether Nintendo Switch Joy-Con controllers will be combined into a single Pro-like controller when using the HIDAPI driver
+  *  A variable controlling whether Nintendo Switch Joy-Con controllers will be combined into a single Pro-like controller when using the HIDAPI driver
   *
   *  This variable can be set to the following values:
   *    "0"       - Left and right Joy-Con controllers will not be combined and each will be a mini-gamepad
@@ -714,7 +713,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_COMBINE_JOY_CONS "SDL_JOYSTICK_HIDAPI_COMBINE_JOY_CONS"
 
 /**
-  *  \brief  A variable controlling whether Nintendo Switch Joy-Con controllers will be in vertical mode when using the HIDAPI driver
+  *  A variable controlling whether Nintendo Switch Joy-Con controllers will be in vertical mode when using the HIDAPI driver
   *
   *  This variable can be set to the following values:
   *    "0"       - Left and right Joy-Con controllers will not be in vertical mode (the default)
@@ -725,7 +724,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_VERTICAL_JOY_CONS "SDL_JOYSTICK_HIDAPI_VERTICAL_JOY_CONS"
 
 /**
-  *  \brief  A variable controlling whether the HIDAPI driver for Amazon Luna controllers connected via Bluetooth should be used.
+  *  A variable controlling whether the HIDAPI driver for Amazon Luna controllers connected via Bluetooth should be used.
   *
   *  This variable can be set to the following values:
   *    "0"       - HIDAPI driver is not used
@@ -736,7 +735,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_LUNA "SDL_JOYSTICK_HIDAPI_LUNA"
 
 /**
-  *  \brief  A variable controlling whether the HIDAPI driver for Nintendo Online classic controllers should be used.
+  *  A variable controlling whether the HIDAPI driver for Nintendo Online classic controllers should be used.
   *
   *  This variable can be set to the following values:
   *    "0"       - HIDAPI driver is not used
@@ -747,7 +746,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_NINTENDO_CLASSIC "SDL_JOYSTICK_HIDAPI_NINTENDO_CLASSIC"
 
 /**
-  *  \brief  A variable controlling whether the HIDAPI driver for NVIDIA SHIELD controllers should be used.
+  *  A variable controlling whether the HIDAPI driver for NVIDIA SHIELD controllers should be used.
   *
   *  This variable can be set to the following values:
   *    "0"       - HIDAPI driver is not used
@@ -758,7 +757,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_SHIELD "SDL_JOYSTICK_HIDAPI_SHIELD"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for PS3 controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for PS3 controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -772,7 +771,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_PS3 "SDL_JOYSTICK_HIDAPI_PS3"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for PS4 controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for PS4 controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -783,7 +782,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_PS4 "SDL_JOYSTICK_HIDAPI_PS4"
 
 /**
- *  \brief  A variable controlling whether extended input reports should be used for PS4 controllers when using the HIDAPI driver.
+ *  A variable controlling whether extended input reports should be used for PS4 controllers when using the HIDAPI driver.
  *
  *  This variable can be set to the following values:
  *    "0"       - extended reports are not enabled (the default)
@@ -803,7 +802,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_PS4_RUMBLE "SDL_JOYSTICK_HIDAPI_PS4_RUMBLE"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for PS5 controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for PS5 controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -814,7 +813,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_PS5 "SDL_JOYSTICK_HIDAPI_PS5"
 
 /**
- *  \brief  A variable controlling whether the player LEDs should be lit to indicate which player is associated with a PS5 controller.
+ *  A variable controlling whether the player LEDs should be lit to indicate which player is associated with a PS5 controller.
  *
  *  This variable can be set to the following values:
  *    "0"       - player LEDs are not enabled
@@ -823,7 +822,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_PS5_PLAYER_LED "SDL_JOYSTICK_HIDAPI_PS5_PLAYER_LED"
 
 /**
- *  \brief  A variable controlling whether extended input reports should be used for PS5 controllers when using the HIDAPI driver.
+ *  A variable controlling whether extended input reports should be used for PS5 controllers when using the HIDAPI driver.
  *
  *  This variable can be set to the following values:
  *    "0"       - extended reports are not enabled (the default)
@@ -842,7 +841,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_PS5_RUMBLE "SDL_JOYSTICK_HIDAPI_PS5_RUMBLE"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for Google Stadia controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for Google Stadia controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -853,7 +852,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_STADIA "SDL_JOYSTICK_HIDAPI_STADIA"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for Bluetooth Steam Controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for Bluetooth Steam Controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -865,7 +864,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_STEAM "SDL_JOYSTICK_HIDAPI_STEAM"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for Nintendo Switch controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for Nintendo Switch controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -876,7 +875,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_SWITCH "SDL_JOYSTICK_HIDAPI_SWITCH"
 
 /**
- *  \brief  A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Pro controller is opened
+ *  A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Pro controller is opened
  *
  *  This variable can be set to the following values:
  *    "0"       - home button LED is turned off
@@ -887,7 +886,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_HOME_LED "SDL_JOYSTICK_HIDAPI_SWITCH_HOME_LED"
 
 /**
- *  \brief  A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Joy-Con controller is opened
+ *  A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Joy-Con controller is opened
  *
  *  This variable can be set to the following values:
  *    "0"       - home button LED is turned off
@@ -898,7 +897,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_JOYCON_HOME_LED "SDL_JOYSTICK_HIDAPI_JOYCON_HOME_LED"
 
 /**
- *  \brief  A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Nintendo Switch controller.
+ *  A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Nintendo Switch controller.
  *
  *  This variable can be set to the following values:
  *    "0"       - player LEDs are not enabled
@@ -907,7 +906,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED "SDL_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for Nintendo Wii and Wii U controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for Nintendo Wii and Wii U controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -918,7 +917,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_WII "SDL_JOYSTICK_HIDAPI_WII"
 
 /**
- *  \brief  A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Wii controller.
+ *  A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Wii controller.
  *
  *  This variable can be set to the following values:
  *    "0"       - player LEDs are not enabled
@@ -927,7 +926,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_WII_PLAYER_LED "SDL_JOYSTICK_HIDAPI_WII_PLAYER_LED"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for XBox controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for XBox controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -938,7 +937,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_XBOX   "SDL_JOYSTICK_HIDAPI_XBOX"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for XBox 360 controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for XBox 360 controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -949,7 +948,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360   "SDL_JOYSTICK_HIDAPI_XBOX_360"
 
 /**
- *  \brief  A variable controlling whether the player LEDs should be lit to indicate which player is associated with an Xbox 360 controller.
+ *  A variable controlling whether the player LEDs should be lit to indicate which player is associated with an Xbox 360 controller.
  *
  *  This variable can be set to the following values:
  *    "0"       - player LEDs are not enabled
@@ -958,7 +957,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED "SDL_JOYSTICK_HIDAPI_XBOX_360_PLAYER_LED"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for XBox 360 wireless controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for XBox 360 wireless controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -969,7 +968,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_360_WIRELESS   "SDL_JOYSTICK_HIDAPI_XBOX_360_WIRELESS"
 
 /**
- *  \brief  A variable controlling whether the HIDAPI driver for XBox One controllers should be used.
+ *  A variable controlling whether the HIDAPI driver for XBox One controllers should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - HIDAPI driver is not used
@@ -980,7 +979,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE   "SDL_JOYSTICK_HIDAPI_XBOX_ONE"
 
 /**
- *  \brief  A variable controlling whether the Home button LED should be turned on when an Xbox One controller is opened
+ *  A variable controlling whether the Home button LED should be turned on when an Xbox One controller is opened
  *
  *  This variable can be set to the following values:
  *    "0"       - home button LED is turned off
@@ -991,7 +990,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_HIDAPI_XBOX_ONE_HOME_LED "SDL_JOYSTICK_HIDAPI_XBOX_ONE_HOME_LED"
 
 /**
-  *  \brief  A variable controlling whether the RAWINPUT joystick drivers should be used for better handling XInput-capable devices.
+  *  A variable controlling whether the RAWINPUT joystick drivers should be used for better handling XInput-capable devices.
   *
   *  This variable can be set to the following values:
   *    "0"       - RAWINPUT drivers are not used
@@ -1000,7 +999,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_RAWINPUT "SDL_JOYSTICK_RAWINPUT"
 
 /**
-  *  \brief  A variable controlling whether the RAWINPUT driver should pull correlated data from XInput.
+  *  A variable controlling whether the RAWINPUT driver should pull correlated data from XInput.
   *
   *  This variable can be set to the following values:
   *    "0"       - RAWINPUT driver will only use data from raw input APIs
@@ -1013,7 +1012,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_RAWINPUT_CORRELATE_XINPUT   "SDL_JOYSTICK_RAWINPUT_CORRELATE_XINPUT"
 
 /**
-  *  \brief  A variable controlling whether the ROG Chakram mice should show up as joysticks
+  *  A variable controlling whether the ROG Chakram mice should show up as joysticks
   *
   *  This variable can be set to the following values:
   *    "0"       - ROG Chakram mice do not show up as joysticks (the default)
@@ -1022,7 +1021,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_ROG_CHAKRAM "SDL_JOYSTICK_ROG_CHAKRAM"
 
 /**
-  *  \brief  A variable controlling whether a separate thread should be used
+  *  A variable controlling whether a separate thread should be used
   *          for handling joystick detection and raw input messages on Windows
   *
   *  This variable can be set to the following values:
@@ -1033,7 +1032,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_THREAD "SDL_JOYSTICK_THREAD"
 
 /**
-  *  \brief  A variable controlling whether Windows.Gaming.Input should be used for controller handling.
+  *  A variable controlling whether Windows.Gaming.Input should be used for controller handling.
   *
   *  This variable can be set to the following values:
   *    "0"       - WGI is not used
@@ -1042,7 +1041,7 @@ extern "C" {
 #define SDL_HINT_JOYSTICK_WGI "SDL_JOYSTICK_WGI"
 
 /**
- * \brief Determines whether SDL enforces that DRM master is required in order
+ * Determines whether SDL enforces that DRM master is required in order
  *        to initialize the KMSDRM video backend.
  *
  * The DRM subsystem has a concept of a "DRM master" which is a DRM client that
@@ -1065,14 +1064,14 @@ extern "C" {
 #define SDL_HINT_KMSDRM_REQUIRE_DRM_MASTER      "SDL_KMSDRM_REQUIRE_DRM_MASTER"
 
 /**
-  *  \brief  A comma separated list of devices to open as joysticks
+  *  A comma separated list of devices to open as joysticks
   *
   *  This variable is currently only used by the Linux joystick driver.
   */
 #define SDL_HINT_JOYSTICK_DEVICE "SDL_JOYSTICK_DEVICE"
 
 /**
-  *  \brief  A variable controlling whether joysticks on Linux will always treat 'hat' axis inputs (ABS_HAT0X - ABS_HAT3Y) as 8-way digital hats without checking whether they may be analog.
+  *  A variable controlling whether joysticks on Linux will always treat 'hat' axis inputs (ABS_HAT0X - ABS_HAT3Y) as 8-way digital hats without checking whether they may be analog.
   *
   *  This variable can be set to the following values:
   *    "0"       - Only map hat axis inputs to digital hat outputs if the input axes appear to actually be digital (the default)
@@ -1081,7 +1080,7 @@ extern "C" {
 #define SDL_HINT_LINUX_DIGITAL_HATS "SDL_LINUX_DIGITAL_HATS"
 
 /**
-  *  \brief  A variable controlling whether digital hats on Linux will apply deadzones to their underlying input axes or use unfiltered values.
+  *  A variable controlling whether digital hats on Linux will apply deadzones to their underlying input axes or use unfiltered values.
   *
   *  This variable can be set to the following values:
   *    "0"       - Return digital hat values based on unfiltered input axis values
@@ -1090,7 +1089,7 @@ extern "C" {
 #define SDL_HINT_LINUX_HAT_DEADZONES "SDL_LINUX_HAT_DEADZONES"
 
 /**
-  *  \brief  A variable controlling whether to use the classic /dev/input/js* joystick interface or the newer /dev/input/event* joystick interface on Linux
+  *  A variable controlling whether to use the classic /dev/input/js* joystick interface or the newer /dev/input/event* joystick interface on Linux
   *
   *  This variable can be set to the following values:
   *    "0"       - Use /dev/input/event*
@@ -1101,7 +1100,7 @@ extern "C" {
 #define SDL_HINT_LINUX_JOYSTICK_CLASSIC "SDL_LINUX_JOYSTICK_CLASSIC"
 
 /**
-  *  \brief  A variable controlling whether joysticks on Linux adhere to their HID-defined deadzones or return unfiltered values.
+  *  A variable controlling whether joysticks on Linux adhere to their HID-defined deadzones or return unfiltered values.
   *
   *  This variable can be set to the following values:
   *    "0"       - Return unfiltered joystick axis values (the default)
@@ -1110,7 +1109,7 @@ extern "C" {
 #define SDL_HINT_LINUX_JOYSTICK_DEADZONES "SDL_LINUX_JOYSTICK_DEADZONES"
 
 /**
-*  \brief  When set don't force the SDL app to become a foreground process
+*  When set don't force the SDL app to become a foreground process
 *
 *  This hint only applies to macOS.
 *
@@ -1118,7 +1117,7 @@ extern "C" {
 #define SDL_HINT_MAC_BACKGROUND_APP    "SDL_MAC_BACKGROUND_APP"
 
 /**
- *  \brief A variable that determines whether ctrl+click should generate a right-click event on Mac
+ *  A variable that determines whether ctrl+click should generate a right-click event on Mac
  *
  *  If present, holding ctrl while left clicking will generate a right click
  *  event when on Mac.
@@ -1126,7 +1125,7 @@ extern "C" {
 #define SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK "SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK"
 
 /**
- *  \brief   A variable controlling whether dispatching OpenGL context updates should block the dispatching thread until the main thread finishes processing
+ *  A variable controlling whether dispatching OpenGL context updates should block the dispatching thread until the main thread finishes processing
  *
  *  This variable can be set to the following values:
  *    "0"       - Dispatching OpenGL context updates will block the dispatching thread until the main thread finishes processing (default).
@@ -1144,17 +1143,17 @@ extern "C" {
 #define SDL_HINT_MAC_OPENGL_ASYNC_DISPATCH "SDL_MAC_OPENGL_ASYNC_DISPATCH"
 
 /**
- *  \brief  A variable setting the double click radius, in pixels.
+ *  A variable setting the double click radius, in pixels.
  */
 #define SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS    "SDL_MOUSE_DOUBLE_CLICK_RADIUS"
 
 /**
- *  \brief  A variable setting the double click time, in milliseconds.
+ *  A variable setting the double click time, in milliseconds.
  */
 #define SDL_HINT_MOUSE_DOUBLE_CLICK_TIME    "SDL_MOUSE_DOUBLE_CLICK_TIME"
 
 /**
- *  \brief Allow mouse click events when clicking to focus an SDL window
+ *  Allow mouse click events when clicking to focus an SDL window
  *
  *  This variable can be set to the following values:
  *    "0"       - Ignore mouse clicks that activate a window
@@ -1165,12 +1164,12 @@ extern "C" {
 #define SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH "SDL_MOUSE_FOCUS_CLICKTHROUGH"
 
 /**
- *  \brief  A variable setting the speed scale for mouse motion, in floating point, when the mouse is not in relative mode
+ *  A variable setting the speed scale for mouse motion, in floating point, when the mouse is not in relative mode
  */
 #define SDL_HINT_MOUSE_NORMAL_SPEED_SCALE    "SDL_MOUSE_NORMAL_SPEED_SCALE"
 
 /**
- *  \brief  A variable controlling whether relative mouse mode constrains the mouse to the center of the window
+ *  A variable controlling whether relative mouse mode constrains the mouse to the center of the window
  *
  *  This variable can be set to the following values:
  *    "0"       - Relative mouse mode constrains the mouse to the window
@@ -1186,7 +1185,7 @@ extern "C" {
 #define SDL_HINT_MOUSE_RELATIVE_MODE_CENTER    "SDL_MOUSE_RELATIVE_MODE_CENTER"
 
 /**
- *  \brief  A variable controlling whether relative mouse mode is implemented using mouse warping
+ *  A variable controlling whether relative mouse mode is implemented using mouse warping
  *
  *  This variable can be set to the following values:
  *    "0"       - Relative mouse mode uses raw input
@@ -1197,12 +1196,12 @@ extern "C" {
 #define SDL_HINT_MOUSE_RELATIVE_MODE_WARP    "SDL_MOUSE_RELATIVE_MODE_WARP"
 
 /**
- *  \brief  A variable setting the scale for mouse motion, in floating point, when the mouse is in relative mode
+ *  A variable setting the scale for mouse motion, in floating point, when the mouse is in relative mode
  */
 #define SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE    "SDL_MOUSE_RELATIVE_SPEED_SCALE"
 
 /**
- *  \brief  A variable controlling whether the system mouse acceleration curve is used for relative mouse motion.
+ *  A variable controlling whether the system mouse acceleration curve is used for relative mouse motion.
  *
  *  This variable can be set to the following values:
  *    "0"       - Relative mouse motion will be unscaled (the default)
@@ -1213,7 +1212,7 @@ extern "C" {
 #define SDL_HINT_MOUSE_RELATIVE_SYSTEM_SCALE    "SDL_MOUSE_RELATIVE_SYSTEM_SCALE"
 
 /**
- *  \brief  A variable controlling whether a motion event should be generated for mouse warping in relative mode.
+ *  A variable controlling whether a motion event should be generated for mouse warping in relative mode.
  *
  *  This variable can be set to the following values:
  *    "0"       - Warping the mouse will not generate a motion event in relative mode
@@ -1224,7 +1223,7 @@ extern "C" {
 #define SDL_HINT_MOUSE_RELATIVE_WARP_MOTION  "SDL_MOUSE_RELATIVE_WARP_MOTION"
 
 /**
- *  \brief  A variable controlling whether mouse events should generate synthetic touch events
+ *  A variable controlling whether mouse events should generate synthetic touch events
  *
  *  This variable can be set to the following values:
  *    "0"       - Mouse events will not generate touch events (default for desktop platforms)
@@ -1233,7 +1232,7 @@ extern "C" {
 #define SDL_HINT_MOUSE_TOUCH_EVENTS    "SDL_MOUSE_TOUCH_EVENTS"
 
 /**
- *  \brief  A variable controlling whether the mouse is captured while mouse buttons are pressed
+ *  A variable controlling whether the mouse is captured while mouse buttons are pressed
  *
  *  This variable can be set to the following values:
  *    "0"       - The mouse is not captured while mouse buttons are pressed
@@ -1246,7 +1245,7 @@ extern "C" {
 #define SDL_HINT_MOUSE_AUTO_CAPTURE    "SDL_MOUSE_AUTO_CAPTURE"
 
 /**
- *  \brief Tell SDL not to catch the SIGINT or SIGTERM signals.
+ *  Tell SDL not to catch the SIGINT or SIGTERM signals.
  *
  * This hint only applies to Unix-like platforms, and should set before
  * any calls to SDL_Init()
@@ -1259,7 +1258,7 @@ extern "C" {
 #define SDL_HINT_NO_SIGNAL_HANDLERS   "SDL_NO_SIGNAL_HANDLERS"
 
 /**
- *  \brief  A variable controlling what driver to use for OpenGL ES contexts.
+ *  A variable controlling what driver to use for OpenGL ES contexts.
  *
  *  On some platforms, currently Windows and X11, OpenGL drivers may support
  *  creating contexts with an OpenGL ES profile. By default SDL uses these
@@ -1290,7 +1289,7 @@ extern "C" {
 #define SDL_HINT_OPENGL_ES_DRIVER   "SDL_OPENGL_ES_DRIVER"
 
 /**
- *  \brief  A variable controlling which orientations are allowed on iOS/Android.
+ *  A variable controlling which orientations are allowed on iOS/Android.
  *
  *  In some circumstances it is necessary to be able to explicitly control
  *  which UI orientations are allowed.
@@ -1301,7 +1300,7 @@ extern "C" {
 #define SDL_HINT_ORIENTATIONS "SDL_IOS_ORIENTATIONS"
 
 /**
- *  \brief  A variable controlling the use of a sentinel event when polling the event queue
+ *  A variable controlling the use of a sentinel event when polling the event queue
  *
  *  This variable can be set to the following values:
  *    "0"       - Disable poll sentinels
@@ -1317,7 +1316,7 @@ extern "C" {
 #define SDL_HINT_POLL_SENTINEL "SDL_POLL_SENTINEL"
 
 /**
- *  \brief Override for SDL_GetPreferredLocales()
+ *  Override for SDL_GetPreferredLocales()
  *
  *  If set, this will be favored over anything the OS might report for the
  *  user's preferred locales. Changing this hint at runtime will not generate
@@ -1331,7 +1330,7 @@ extern "C" {
 #define SDL_HINT_PREFERRED_LOCALES "SDL_PREFERRED_LOCALES"
 
 /**
- *  \brief  A variable describing the content orientation on QtWayland-based platforms.
+ *  A variable describing the content orientation on QtWayland-based platforms.
  *
  *  On QtWayland platforms, windows are rotated client-side to allow for custom
  *  transitions. In order to correctly position overlays (e.g. volume bar) and
@@ -1350,7 +1349,7 @@ extern "C" {
 #define SDL_HINT_QTWAYLAND_CONTENT_ORIENTATION "SDL_QTWAYLAND_CONTENT_ORIENTATION"
 
 /**
- *  \brief  Flags to set on QtWayland windows to integrate with the native window manager.
+ *  Flags to set on QtWayland windows to integrate with the native window manager.
  *
  *  On QtWayland platforms, this hint controls the flags to set on the windows.
  *  For example, on Sailfish OS "OverridesSystemGestures" disables swipe gestures.
@@ -1361,7 +1360,7 @@ extern "C" {
 #define SDL_HINT_QTWAYLAND_WINDOW_FLAGS "SDL_QTWAYLAND_WINDOW_FLAGS"
 
 /**
- *  \brief  A variable controlling whether the 2D render API is compatible or efficient.
+ *  A variable controlling whether the 2D render API is compatible or efficient.
  *
  *  This variable can be set to the following values:
  *
@@ -1385,7 +1384,7 @@ extern "C" {
 #define SDL_HINT_RENDER_BATCHING  "SDL_RENDER_BATCHING"
 
 /**
- *  \brief  A variable controlling how the 2D render API renders lines
+ *  A variable controlling how the 2D render API renders lines
  *
  *  This variable can be set to the following values:
  *    "0"     - Use the default line drawing method (Bresenham's line algorithm as of SDL 2.0.20)
@@ -1398,7 +1397,7 @@ extern "C" {
 #define SDL_HINT_RENDER_LINE_METHOD "SDL_RENDER_LINE_METHOD"
 
 /**
- *  \brief  A variable controlling whether to enable Direct3D 11+'s Debug Layer.
+ *  A variable controlling whether to enable Direct3D 11+'s Debug Layer.
  *
  *  This variable does not have any effect on the Direct3D 9 based renderer.
  *
@@ -1411,7 +1410,7 @@ extern "C" {
 #define SDL_HINT_RENDER_DIRECT3D11_DEBUG    "SDL_RENDER_DIRECT3D11_DEBUG"
 
 /**
- *  \brief  A variable controlling whether the Direct3D device is initialized for thread-safe operations.
+ *  A variable controlling whether the Direct3D device is initialized for thread-safe operations.
  *
  *  This variable can be set to the following values:
  *    "0"       - Thread-safety is not enabled (faster)
@@ -1422,7 +1421,7 @@ extern "C" {
 #define SDL_HINT_RENDER_DIRECT3D_THREADSAFE "SDL_RENDER_DIRECT3D_THREADSAFE"
 
 /**
- *  \brief  A variable specifying which render driver to use.
+ *  A variable specifying which render driver to use.
  *
  *  If the application doesn't pick a specific renderer to use, this variable
  *  specifies the name of the preferred renderer.  If the preferred renderer
@@ -1444,7 +1443,7 @@ extern "C" {
 #define SDL_HINT_RENDER_DRIVER              "SDL_RENDER_DRIVER"
 
 /**
- *  \brief  A variable controlling whether the OpenGL render driver uses shaders if they are available.
+ *  A variable controlling whether the OpenGL render driver uses shaders if they are available.
  *
  *  This variable can be set to the following values:
  *    "0"       - Disable shaders
@@ -1455,7 +1454,7 @@ extern "C" {
 #define SDL_HINT_RENDER_OPENGL_SHADERS      "SDL_RENDER_OPENGL_SHADERS"
 
 /**
- *  \brief  A variable controlling the scaling quality
+ *  A variable controlling the scaling quality
  *
  *  This variable can be set to the following values:
  *    "0" or "nearest" - Nearest pixel sampling
@@ -1467,7 +1466,7 @@ extern "C" {
 #define SDL_HINT_RENDER_SCALE_QUALITY       "SDL_RENDER_SCALE_QUALITY"
 
 /**
- *  \brief  A variable controlling whether updates to the SDL screen surface should be synchronized with the vertical refresh, to avoid tearing.
+ *  A variable controlling whether updates to the SDL screen surface should be synchronized with the vertical refresh, to avoid tearing.
  *
  *  This variable can be set to the following values:
  *    "0"       - Disable vsync
@@ -1478,7 +1477,7 @@ extern "C" {
 #define SDL_HINT_RENDER_VSYNC               "SDL_RENDER_VSYNC"
 
 /**
- *  \brief  A variable controlling whether the Metal render driver select low power device over default one
+ *  A variable controlling whether the Metal render driver select low power device over default one
  *
  *  This variable can be set to the following values:
  *    "0"       - Use the prefered OS device
@@ -1489,7 +1488,7 @@ extern "C" {
 #define SDL_HINT_RENDER_METAL_PREFER_LOW_POWER_DEVICE "SDL_RENDER_METAL_PREFER_LOW_POWER_DEVICE"
 
 /**
- *  \brief  A variable controlling if VSYNC is automatically disable if doesn't reach the enough FPS
+ *  A variable controlling if VSYNC is automatically disable if doesn't reach the enough FPS
  *
  *  This variable can be set to the following values:
  *    "0"       - It will be using VSYNC as defined in the main flag. Default
@@ -1500,7 +1499,7 @@ extern "C" {
 #define SDL_HINT_PS2_DYNAMIC_VSYNC    "SDL_PS2_DYNAMIC_VSYNC"
 
 /**
- * \brief A variable to control whether the return key on the soft keyboard
+ * A variable to control whether the return key on the soft keyboard
  *        should hide the soft keyboard on Android and iOS.
  *
  * The variable can be set to the following values:
@@ -1512,7 +1511,7 @@ extern "C" {
 #define SDL_HINT_RETURN_KEY_HIDES_IME "SDL_RETURN_KEY_HIDES_IME"
 
 /**
- * \brief Tell SDL which Dispmanx layer to use on a Raspberry PI
+ * Tell SDL which Dispmanx layer to use on a Raspberry PI
  *
  * Also known as Z-order. The variable can take a negative or positive value.
  * The default is 10000.
@@ -1520,7 +1519,7 @@ extern "C" {
 #define SDL_HINT_RPI_VIDEO_LAYER           "SDL_RPI_VIDEO_LAYER"
 
 /**
- *  \brief Specify an "activity name" for screensaver inhibition.
+ *  Specify an "activity name" for screensaver inhibition.
  *
  * Some platforms, notably Linux desktops, list the applications which are
  * inhibiting the screensaver or other power-saving features.
@@ -1540,7 +1539,7 @@ extern "C" {
 #define SDL_HINT_SCREENSAVER_INHIBIT_ACTIVITY_NAME "SDL_SCREENSAVER_INHIBIT_ACTIVITY_NAME"
 
 /**
- *  \brief Specifies whether SDL_THREAD_PRIORITY_TIME_CRITICAL should be treated as realtime.
+ *  Specifies whether SDL_THREAD_PRIORITY_TIME_CRITICAL should be treated as realtime.
  *
  *  On some platforms, like Linux, a realtime priority thread may be subject to restrictions
  *  that require special handling by the application. This hint exists to let SDL know that
@@ -1559,7 +1558,7 @@ extern "C" {
 #define SDL_HINT_THREAD_FORCE_REALTIME_TIME_CRITICAL "SDL_THREAD_FORCE_REALTIME_TIME_CRITICAL"
 
 /**
-*  \brief  A string specifying additional information to use with SDL_SetThreadPriority.
+*  A string specifying additional information to use with SDL_SetThreadPriority.
 *
 *  By default SDL_SetThreadPriority will make appropriate system changes in order to
 *  apply a thread priority.  For example on systems using pthreads the scheduler policy
@@ -1576,7 +1575,7 @@ extern "C" {
 #define SDL_HINT_THREAD_PRIORITY_POLICY         "SDL_THREAD_PRIORITY_POLICY"
 
 /**
-*  \brief  A string specifying SDL's threads stack size in bytes or "0" for the backend's default size
+*  A string specifying SDL's threads stack size in bytes or "0" for the backend's default size
 *
 *  Use this hint in case you need to set SDL's threads stack size to other than the default.
 *  This is specially useful if you build SDL against a non glibc libc library (such as musl) which
@@ -1590,7 +1589,7 @@ extern "C" {
 #define SDL_HINT_THREAD_STACK_SIZE              "SDL_THREAD_STACK_SIZE"
 
 /**
- *  \brief A variable that controls the timer resolution, in milliseconds.
+ *  A variable that controls the timer resolution, in milliseconds.
  *
  *  The higher resolution the timer, the more frequently the CPU services
  *  timer interrupts, and the more precise delays are, but this takes up
@@ -1606,7 +1605,7 @@ extern "C" {
 #define SDL_HINT_TIMER_RESOLUTION "SDL_TIMER_RESOLUTION"
 
 /**
- *  \brief  A variable controlling whether touch events should generate synthetic mouse events
+ *  A variable controlling whether touch events should generate synthetic mouse events
  *
  *  This variable can be set to the following values:
  *    "0"       - Touch events will not generate mouse events
@@ -1617,7 +1616,7 @@ extern "C" {
 #define SDL_HINT_TOUCH_MOUSE_EVENTS    "SDL_TOUCH_MOUSE_EVENTS"
 
 /**
- *  \brief  A variable controlling which touchpad should generate synthetic mouse events
+ *  A variable controlling which touchpad should generate synthetic mouse events
  *
  *  This variable can be set to the following values:
  *    "0"       - Only front touchpad should generate mouse events. Default
@@ -1629,7 +1628,7 @@ extern "C" {
 #define SDL_HINT_VITA_TOUCH_MOUSE_DEVICE    "SDL_HINT_VITA_TOUCH_MOUSE_DEVICE"
 
 /**
- *  \brief  A variable controlling whether the Android / tvOS remotes
+ *  A variable controlling whether the Android / tvOS remotes
  *  should be listed as joystick devices, instead of sending keyboard events.
  *
  *  This variable can be set to the following values:
@@ -1639,7 +1638,7 @@ extern "C" {
 #define SDL_HINT_TV_REMOTE_AS_JOYSTICK "SDL_TV_REMOTE_AS_JOYSTICK"
 
 /**
- *  \brief  A variable controlling whether the screensaver is enabled.
+ *  A variable controlling whether the screensaver is enabled.
  *
  *  This variable can be set to the following values:
  *    "0"       - Disable screensaver
@@ -1650,7 +1649,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_ALLOW_SCREENSAVER    "SDL_VIDEO_ALLOW_SCREENSAVER"
 
 /**
- * \brief Tell the video driver that we only want a double buffer.
+ * Tell the video driver that we only want a double buffer.
  *
  * By default, most lowlevel 2D APIs will use a triple buffer scheme that
  * wastes no CPU time on waiting for vsync after issuing a flip, but
@@ -1669,7 +1668,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_DOUBLE_BUFFER      "SDL_VIDEO_DOUBLE_BUFFER"
 
 /**
- * \brief If eglGetPlatformDisplay fails, fall back to calling eglGetDisplay.
+ * If eglGetPlatformDisplay fails, fall back to calling eglGetDisplay.
  *
  * This variable can be set to one of the following values:
  *   "0"        - Do not fall back to eglGetDisplay
@@ -1681,7 +1680,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_EGL_ALLOW_GETDISPLAY_FALLBACK "SDL_VIDEO_EGL_GETDISPLAY_FALLBACK"
 
 /**
- * \brief A variable controlling whether the graphics context is externally managed.
+ * A variable controlling whether the graphics context is externally managed.
  *
  * This variable can be set to the following values:
  *  "0"         - SDL will manage graphics contexts that are attached to windows.
@@ -1696,7 +1695,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_EXTERNAL_CONTEXT    "SDL_VIDEO_EXTERNAL_CONTEXT"
 
 /**
- *  \brief  A variable that dictates policy for fullscreen Spaces on macOS.
+ *  A variable that dictates policy for fullscreen Spaces on macOS.
  *
  *  This hint only applies to macOS.
  *
@@ -1713,7 +1712,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES    "SDL_VIDEO_MAC_FULLSCREEN_SPACES"
 
 /**
- *  \brief Minimize your SDL_Window if it loses key focus when in fullscreen mode. Defaults to false.
+ *  Minimize your SDL_Window if it loses key focus when in fullscreen mode. Defaults to false.
  *  \warning  Before SDL 2.0.14, this defaulted to true! In 2.0.14, we're
  *            seeing if "true" causes more problems than it solves in modern times.
  *
@@ -1721,7 +1720,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS   "SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS"
 
 /**
- *  \brief  A variable controlling whether the libdecor Wayland backend is allowed to be used.
+ *  A variable controlling whether the libdecor Wayland backend is allowed to be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - libdecor use is disabled.
@@ -1732,7 +1731,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_WAYLAND_ALLOW_LIBDECOR "SDL_VIDEO_WAYLAND_ALLOW_LIBDECOR"
 
 /**
- *  \brief  A variable controlling whether the libdecor Wayland backend is preferred over native decrations.
+ *  A variable controlling whether the libdecor Wayland backend is preferred over native decrations.
  *
  *  When this hint is set, libdecor will be used to provide window decorations, even if xdg-decoration is
  *  available. (Note that, by default, libdecor will use xdg-decoration itself if available).
@@ -1746,7 +1745,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_WAYLAND_PREFER_LIBDECOR "SDL_VIDEO_WAYLAND_PREFER_LIBDECOR"
 
 /**
- *  \brief  A variable controlling whether video mode emulation is enabled under Wayland.
+ *  A variable controlling whether video mode emulation is enabled under Wayland.
  *
  *  When this hint is set, a standard set of emulated CVT video modes will be exposed for use by the application.
  *  If it is disabled, the only modes exposed will be the logical desktop size and, in the case of a scaled
@@ -1761,7 +1760,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_WAYLAND_MODE_EMULATION "SDL_VIDEO_WAYLAND_MODE_EMULATION"
 
 /**
- *  \brief  A variable controlling how modes with a non-native aspect ratio are displayed under Wayland.
+ *  A variable controlling how modes with a non-native aspect ratio are displayed under Wayland.
  *
  *  When this hint is set, the requested scaling will be used when displaying fullscreen video modes
  *  that don't match the display's native aspect ratio. This is contingent on compositor viewport support.
@@ -1776,7 +1775,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_WAYLAND_MODE_SCALING "SDL_VIDEO_WAYLAND_MODE_SCALING"
 
 /**
- *  \brief  Enable or disable mouse pointer warp emulation, needed by some older games.
+ *  Enable or disable mouse pointer warp emulation, needed by some older games.
  *
  *  When this hint is set, any SDL will emulate mouse warps using relative mouse mode.
  *  This is required for some older games (such as Source engine games), which warp the
@@ -1793,7 +1792,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_WAYLAND_EMULATE_MOUSE_WARP "SDL_VIDEO_WAYLAND_EMULATE_MOUSE_WARP"
 
 /**
-*  \brief  A variable that is the address of another SDL_Window* (as a hex string formatted with "%p").
+*  A variable that is the address of another SDL_Window* (as a hex string formatted with "%p").
 *
 *  If this hint is set before SDL_CreateWindowFrom() and the SDL_Window* it is set to has
 *  SDL_WINDOW_OPENGL set (and running on WGL only, currently), then two things will occur on the newly
@@ -1812,7 +1811,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT    "SDL_VIDEO_WINDOW_SHARE_PIXEL_FORMAT"
 
 /**
- *  \brief  When calling SDL_CreateWindowFrom(), make the window compatible with OpenGL.
+ *  When calling SDL_CreateWindowFrom(), make the window compatible with OpenGL.
  *
  * This variable can be set to the following values:
  * "0" - Don't add any graphics flags to the SDL_WindowFlags
@@ -1823,7 +1822,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_FOREIGN_WINDOW_OPENGL "SDL_VIDEO_FOREIGN_WINDOW_OPENGL"
 
 /**
- *  \brief  When calling SDL_CreateWindowFrom(), make the window compatible with Vulkan.
+ *  When calling SDL_CreateWindowFrom(), make the window compatible with Vulkan.
  *
  * This variable can be set to the following values:
  * "0" - Don't add any graphics flags to the SDL_WindowFlags
@@ -1834,7 +1833,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_FOREIGN_WINDOW_VULKAN "SDL_VIDEO_FOREIGN_WINDOW_VULKAN"
 
 /**
-*  \brief  A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries
+*  A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries
 *
 *  SDL has EGL and OpenGL ES2 support on Windows via the ANGLE project. It
 *  can use two different sets of binaries, those compiled by the user from source
@@ -1850,8 +1849,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_WIN_D3DCOMPILER              "SDL_VIDEO_WIN_D3DCOMPILER"
 
 /**
- * \brief A variable controlling whether the OpenGL context should be created
- * with EGL by default
+ * Set whether the OpenGL context should be created with EGL by default
  *
  * This variable can be set to the following values:
  * "0" - Use platform-specific GL context creation API (GLX, WGL, CGL, etc)
@@ -1862,7 +1860,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_FORCE_EGL "SDL_VIDEO_FORCE_EGL"
 
 /**
- * \brief A variable controlling whether the X11 _NET_WM_BYPASS_COMPOSITOR hint should be used.
+ * A variable controlling whether the X11 _NET_WM_BYPASS_COMPOSITOR hint should be used.
  *
  * This variable can be set to the following values:
  * "0" - Disable _NET_WM_BYPASS_COMPOSITOR
@@ -1874,7 +1872,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR "SDL_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR"
 
 /**
- *  \brief  A variable controlling whether the X11 _NET_WM_PING protocol should be supported.
+ *  A variable controlling whether the X11 _NET_WM_PING protocol should be supported.
  *
  *  This variable can be set to the following values:
  *    "0"       - Disable _NET_WM_PING
@@ -1888,20 +1886,20 @@ extern "C" {
 #define SDL_HINT_VIDEO_X11_NET_WM_PING      "SDL_VIDEO_X11_NET_WM_PING"
 
 /**
- *  \brief  A variable forcing the visual ID chosen for new X11 windows
+ *  A variable forcing the visual ID chosen for new X11 windows
  *
  */
 #define SDL_HINT_VIDEO_X11_WINDOW_VISUALID      "SDL_VIDEO_X11_WINDOW_VISUALID"
 
 /**
- *  \brief  A variable forcing the scaling factor for X11 windows
+ *  A variable forcing the scaling factor for X11 windows
  *
  *  This variable can be set to a floating point value in the range 1.0-10.0f
  */
 #define SDL_HINT_VIDEO_X11_SCALING_FACTOR      "SDL_VIDEO_X11_SCALING_FACTOR"
 
 /**
- *  \brief  A variable controlling whether the X11 XRandR extension should be used.
+ *  A variable controlling whether the X11 XRandR extension should be used.
  *
  *  This variable can be set to the following values:
  *    "0"       - Disable XRandR
@@ -1912,7 +1910,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_X11_XRANDR           "SDL_VIDEO_X11_XRANDR"
 
 /**
- *  \brief  Controls how the fact chunk affects the loading of a WAVE file.
+ *  Controls how the fact chunk affects the loading of a WAVE file.
  *
  *  The fact chunk stores information about the number of samples of a WAVE
  *  file. The Standards Update from Microsoft notes that this value can be used
@@ -1939,7 +1937,7 @@ extern "C" {
 #define SDL_HINT_WAVE_FACT_CHUNK   "SDL_WAVE_FACT_CHUNK"
 
 /**
- *  \brief  Controls how the size of the RIFF chunk affects the loading of a WAVE file.
+ *  Controls how the size of the RIFF chunk affects the loading of a WAVE file.
  *
  *  The size of the RIFF chunk (which includes all the sub-chunks of the WAVE
  *  file) is not always reliable. In case the size is wrong, it's possible to
@@ -1960,7 +1958,7 @@ extern "C" {
 #define SDL_HINT_WAVE_RIFF_CHUNK_SIZE   "SDL_WAVE_RIFF_CHUNK_SIZE"
 
 /**
- *  \brief  Controls how a truncated WAVE file is handled.
+ *  Controls how a truncated WAVE file is handled.
  *
  *  A WAVE file is considered truncated if any of the chunks are incomplete or
  *  the data chunk size is not a multiple of the block size. By default, SDL
@@ -1976,7 +1974,7 @@ extern "C" {
 #define SDL_HINT_WAVE_TRUNCATION   "SDL_WAVE_TRUNCATION"
 
 /**
- * \brief Tell SDL not to name threads on Windows with the 0x406D1388 Exception.
+ * Tell SDL not to name threads on Windows with the 0x406D1388 Exception.
  *        The 0x406D1388 Exception is a trick used to inform Visual Studio of a
  *        thread's name, but it tends to cause problems with other debuggers,
  *        and the .NET runtime. Note that SDL 2.0.6 and later will still use
@@ -1992,7 +1990,7 @@ extern "C" {
 #define SDL_HINT_WINDOWS_DISABLE_THREAD_NAMING "SDL_WINDOWS_DISABLE_THREAD_NAMING"
 
 /**
- *  \brief Controls whether menus can be opened with their keyboard shortcut (Alt+mnemonic).
+ *  Controls whether menus can be opened with their keyboard shortcut (Alt+mnemonic).
  *
  *  If the mnemonics are enabled, then menus can be opened by pressing the Alt
  *  key and the corresponding mnemonic (for example, Alt+F opens the File menu).
@@ -2014,7 +2012,7 @@ extern "C" {
 #define SDL_HINT_WINDOWS_ENABLE_MENU_MNEMONICS "SDL_WINDOWS_ENABLE_MENU_MNEMONICS"
 
 /**
- *  \brief  A variable controlling whether the windows message loop is processed by SDL
+ *  A variable controlling whether the windows message loop is processed by SDL
  *
  *  This variable can be set to the following values:
  *    "0"       - The window message loop is not run
@@ -2025,7 +2023,7 @@ extern "C" {
 #define SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP "SDL_WINDOWS_ENABLE_MESSAGELOOP"
 
 /**
- * \brief Force SDL to use Critical Sections for mutexes on Windows.
+ * Force SDL to use Critical Sections for mutexes on Windows.
  *        On Windows 7 and newer, Slim Reader/Writer Locks are available.
  *        They offer better performance, allocate no kernel resources and
  *        use less memory. SDL will fall back to Critical Sections on older
@@ -2039,7 +2037,7 @@ extern "C" {
 #define SDL_HINT_WINDOWS_FORCE_MUTEX_CRITICAL_SECTIONS "SDL_WINDOWS_FORCE_MUTEX_CRITICAL_SECTIONS"
 
 /**
- * \brief Force SDL to use Kernel Semaphores on Windows.
+ * Force SDL to use Kernel Semaphores on Windows.
  *        Kernel Semaphores are inter-process and require a context
  *        switch on every interaction. On Windows 8 and newer, the
  *        WaitOnAddress API is available. Using that and atomics to
@@ -2055,13 +2053,13 @@ extern "C" {
 #define SDL_HINT_WINDOWS_FORCE_SEMAPHORE_KERNEL "SDL_WINDOWS_FORCE_SEMAPHORE_KERNEL"
 
 /**
- * \brief A variable to specify custom icon resource id from RC file on Windows platform
+ * A variable to specify custom icon resource id from RC file on Windows platform
  */
 #define SDL_HINT_WINDOWS_INTRESOURCE_ICON       "SDL_WINDOWS_INTRESOURCE_ICON"
 #define SDL_HINT_WINDOWS_INTRESOURCE_ICON_SMALL "SDL_WINDOWS_INTRESOURCE_ICON_SMALL"
 
 /**
- *  \brief Tell SDL not to generate window-close events for Alt+F4 on Windows.
+ *  Tell SDL not to generate window-close events for Alt+F4 on Windows.
  *
  * The variable can be set to the following values:
  *   "0"       - SDL will generate a window-close event when it sees Alt+F4.
@@ -2070,7 +2068,7 @@ extern "C" {
 #define SDL_HINT_WINDOWS_NO_CLOSE_ON_ALT_F4 "SDL_WINDOWS_NO_CLOSE_ON_ALT_F4"
 
 /**
- * \brief Use the D3D9Ex API introduced in Windows Vista, instead of normal D3D9.
+ * Use the D3D9Ex API introduced in Windows Vista, instead of normal D3D9.
  *        Direct3D 9Ex contains changes to state management that can eliminate device
  *        loss errors during scenarios like Alt+Tab or UAC prompts. D3D9Ex may require
  *        some changes to your application to cope with the new behavior, so this
@@ -2090,7 +2088,7 @@ extern "C" {
 #define SDL_HINT_WINDOWS_USE_D3D9EX "SDL_WINDOWS_USE_D3D9EX"
 
 /**
- *  \brief  A variable controlling whether the window frame and title bar are interactive when the cursor is hidden
+ *  A variable controlling whether the window frame and title bar are interactive when the cursor is hidden
  *
  *  This variable can be set to the following values:
  *    "0"       - The window frame is not interactive when the cursor is hidden (no move, resize, etc)
@@ -2101,7 +2099,7 @@ extern "C" {
 #define SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN    "SDL_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN"
 
 /**
-*  \brief  A variable controlling whether the window is activated when the SDL_ShowWindow function is called
+*  A variable controlling whether the window is activated when the SDL_ShowWindow function is called
 *
 *  This variable can be set to the following values:
 *    "0"       - The window is not activated when the SDL_ShowWindow function is called
@@ -2111,7 +2109,7 @@ extern "C" {
 */
 #define SDL_HINT_WINDOW_ACTIVATE_WHEN_SHOWN    "SDL_WINDOW_ACTIVATE_WHEN_SHOWN"
 
-/** \brief Allows back-button-press events on Windows Phone to be marked as handled
+/** Allows back-button-press events on Windows Phone to be marked as handled
  *
  *  Windows Phone devices typically feature a Back button.  When pressed,
  *  the OS will emit back-button-press events, which apps are expected to
@@ -2163,7 +2161,7 @@ extern "C" {
  */
 #define SDL_HINT_WINRT_HANDLE_BACK_BUTTON "SDL_WINRT_HANDLE_BACK_BUTTON"
 
-/** \brief Label text for a WinRT app's privacy policy link
+/** Label text for a WinRT app's privacy policy link
  *
  *  Network-enabled WinRT apps must include a privacy policy.  On Windows 8, 8.1, and RT,
  *  Microsoft mandates that this policy be available via the Windows Settings charm.
@@ -2185,7 +2183,7 @@ extern "C" {
 #define SDL_HINT_WINRT_PRIVACY_POLICY_LABEL "SDL_WINRT_PRIVACY_POLICY_LABEL"
 
 /**
- *  \brief A URL to a WinRT app's privacy policy
+ *  A URL to a WinRT app's privacy policy
  *
  *  All network-enabled WinRT apps must make a privacy policy available to its
  *  users.  On Windows 8, 8.1, and RT, Microsoft mandates that this policy be
@@ -2211,7 +2209,7 @@ extern "C" {
 #define SDL_HINT_WINRT_PRIVACY_POLICY_URL "SDL_WINRT_PRIVACY_POLICY_URL"
 
 /**
- *  \brief Mark X11 windows as override-redirect.
+ *  Mark X11 windows as override-redirect.
  *
  *  If set, this _might_ increase framerate at the expense of the desktop
  *  not working as expected. Override-redirect windows aren't noticed by the
@@ -2223,7 +2221,7 @@ extern "C" {
 #define SDL_HINT_X11_FORCE_OVERRIDE_REDIRECT "SDL_X11_FORCE_OVERRIDE_REDIRECT"
 
 /**
- *  \brief  A variable that lets you disable the detection and use of Xinput gamepad devices
+ *  A variable that lets you disable the detection and use of Xinput gamepad devices
  *
  *  The variable can be set to the following values:
  *    "0"       - Disable XInput detection (only uses direct input)
@@ -2232,7 +2230,7 @@ extern "C" {
 #define SDL_HINT_XINPUT_ENABLED "SDL_XINPUT_ENABLED"
 
  /**
-  *  \brief  A variable that lets you disable the detection and use of DirectInput gamepad devices
+  *  A variable that lets you disable the detection and use of DirectInput gamepad devices
   *
   *  The variable can be set to the following values:
   *    "0"       - Disable DirectInput detection (only uses XInput)
@@ -2241,7 +2239,7 @@ extern "C" {
 #define SDL_HINT_DIRECTINPUT_ENABLED "SDL_DIRECTINPUT_ENABLED"
 
 /**
- *  \brief  A variable that causes SDL to use the old axis and button mapping for XInput devices.
+ *  A variable that causes SDL to use the old axis and button mapping for XInput devices.
  *
  *  This hint is for backwards compatibility only and will be removed in SDL 2.1
  *
@@ -2250,7 +2248,7 @@ extern "C" {
 #define SDL_HINT_XINPUT_USE_OLD_JOYSTICK_MAPPING "SDL_XINPUT_USE_OLD_JOYSTICK_MAPPING"
 
 /**
- *  \brief  A variable that causes SDL to not ignore audio "monitors"
+ *  A variable that causes SDL to not ignore audio "monitors"
  *
  *  This is currently only used for PulseAudio and ignored elsewhere.
  *
@@ -2269,7 +2267,7 @@ extern "C" {
 #define SDL_HINT_AUDIO_INCLUDE_MONITORS "SDL_AUDIO_INCLUDE_MONITORS"
 
 /**
- *  \brief  A variable that forces X11 windows to create as a custom type.
+ *  A variable that forces X11 windows to create as a custom type.
  *
  *  This is currently only used for X11 and ignored elsewhere.
  *
@@ -2289,7 +2287,7 @@ extern "C" {
 #define SDL_HINT_X11_WINDOW_TYPE "SDL_X11_WINDOW_TYPE"
 
 /**
- *  \brief  A variable that decides whether to send SDL_EVENT_QUIT when closing the final window.
+ *  A variable that decides whether to send SDL_EVENT_QUIT when closing the final window.
  *
  *  By default, SDL sends an SDL_EVENT_QUIT event when there is only one window
  *  and it receives an SDL_EVENT_WINDOW_CLOSE_REQUESTED event, under the assumption most
@@ -2314,7 +2312,7 @@ extern "C" {
 
 
 /**
- *  \brief  A variable that decides what video backend to use.
+ *  A variable that decides what video backend to use.
  *
  *  By default, SDL will try all available video backends in a reasonable
  *  order until it finds one that can work, but this hint allows the app
@@ -2337,7 +2335,7 @@ extern "C" {
 #define SDL_HINT_VIDEO_DRIVER "SDL_VIDEO_DRIVER"
 
 /**
- *  \brief  A variable that decides what audio backend to use.
+ *  A variable that decides what audio backend to use.
  *
  *  By default, SDL will try all available audio backends in a reasonable
  *  order until it finds one that can work, but this hint allows the app
@@ -2360,7 +2358,7 @@ extern "C" {
 #define SDL_HINT_AUDIO_DRIVER "SDL_AUDIO_DRIVER"
 
 /**
- *  \brief  A variable that decides what KMSDRM device to use.
+ *  A variable that decides what KMSDRM device to use.
  *
  *  Internally, SDL might open something like "/dev/dri/cardNN" to
  *  access KMSDRM functionality, where "NN" is a device index number.
@@ -2375,7 +2373,7 @@ extern "C" {
 
 
 /**
- *  \brief  A variable that treats trackpads as touch devices.
+ *  A variable that treats trackpads as touch devices.
  *
  *  On macOS (and possibly other platforms in the future), SDL will report
  *  touches on a trackpad as mouse input, which is generally what users
@@ -2397,7 +2395,7 @@ extern "C" {
 
 
 /**
- *  \brief  Sets the title of the TextInput window on GDK platforms.
+ *  Sets the title of the TextInput window on GDK platforms.
  *
  *  On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
  *  standard SDL text input and virtual keyboard capabilities
@@ -2416,7 +2414,7 @@ extern "C" {
 #define SDL_HINT_GDK_TEXTINPUT_TITLE "SDL_GDK_TEXTINPUT_TITLE"
 
 /**
- *  \brief  Sets the description of the TextInput window on GDK platforms.
+ *  Sets the description of the TextInput window on GDK platforms.
  *
  *  On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
  *  standard SDL text input and virtual keyboard capabilities
@@ -2435,7 +2433,7 @@ extern "C" {
 #define SDL_HINT_GDK_TEXTINPUT_DESCRIPTION "SDL_GDK_TEXTINPUT_DESCRIPTION"
 
 /**
- *  \brief  Sets the default text of the TextInput window on GDK platforms.
+ *  Sets the default text of the TextInput window on GDK platforms.
  *
  *  On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
  *  standard SDL text input and virtual keyboard capabilities
@@ -2454,7 +2452,7 @@ extern "C" {
 #define SDL_HINT_GDK_TEXTINPUT_DEFAULT "SDL_GDK_TEXTINPUT_DEFAULT"
 
 /**
- *  \brief  Sets the input scope of the TextInput window on GDK platforms.
+ *  Sets the input scope of the TextInput window on GDK platforms.
  *
  *  On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
  *  standard SDL text input and virtual keyboard capabilities
@@ -2477,7 +2475,7 @@ extern "C" {
 #define SDL_HINT_GDK_TEXTINPUT_SCOPE "SDL_GDK_TEXTINPUT_SCOPE"
 
 /**
- *  \brief  Sets the maximum input length of the TextInput window on GDK platforms.
+ *  Sets the maximum input length of the TextInput window on GDK platforms.
  *
  *  On GDK, if SDL_GDK_TEXTINPUT is defined, you can use the
  *  standard SDL text input and virtual keyboard capabilities
@@ -2537,7 +2535,7 @@ extern "C" {
 
 
 /**
- *  \brief  An enumeration of hint priorities
+ *  An enumeration of hint priorities
  */
 typedef enum
 {

+ 2 - 2
include/SDL3/SDL_init.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_init.h
  *
- *  \brief Init and quit header for the SDL library
+ *  Init and quit header for the SDL library
  */
 
 #ifndef SDL_init_h_
@@ -39,7 +39,7 @@ extern "C" {
 /* As of version 0.5, SDL is loaded dynamically into the application */
 
 /**
- *   \brief Initialization flags for SDL_Init and/or SDL_InitSubSystem
+ *   Initialization flags for SDL_Init and/or SDL_InitSubSystem
  *
  * These are the flags which may be passed to SDL_Init().  You should
  * specify the subsystems which you will be using in your application.

+ 1 - 1
include/SDL3/SDL_intrin.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_intrin.h
  *
- *  \brief Header file for CPU intrinsics for SDL
+ *  Header file for CPU intrinsics for SDL
  */
 
 #ifndef SDL_intrin_h_

+ 2 - 2
include/SDL3/SDL_joystick.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_joystick.h
  *
- *  \brief Include file for SDL joystick event handling
+ *  Include file for SDL joystick event handling
  *
  *  The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
  *    then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
@@ -359,7 +359,7 @@ typedef struct SDL_VirtualJoystickDesc
 } SDL_VirtualJoystickDesc;
 
 /**
- * \brief The current version of the SDL_VirtualJoystickDesc structure
+ * The current version of the SDL_VirtualJoystickDesc structure
  */
 #define SDL_VIRTUAL_JOYSTICK_DESC_VERSION   1
 

+ 2 - 2
include/SDL3/SDL_keyboard.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_keyboard.h
  *
- *  \brief Include file for SDL keyboard event handling
+ *  Include file for SDL keyboard event handling
  */
 
 #ifndef SDL_keyboard_h_
@@ -40,7 +40,7 @@ extern "C" {
 #endif
 
 /**
- *  \brief The SDL keysym structure, used in key events.
+ *  The SDL keysym structure, used in key events.
  *
  *  \note  If you are looking for translated character input, see the ::SDL_EVENT_TEXT_INPUT event.
  */

+ 3 - 3
include/SDL3/SDL_keycode.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_keycode.h
  *
- *  \brief Defines constants which identify keyboard keys and modifiers.
+ *  Defines constants which identify keyboard keys and modifiers.
  */
 
 #ifndef SDL_keycode_h_
@@ -32,7 +32,7 @@
 #include <SDL3/SDL_scancode.h>
 
 /**
- *  \brief The SDL virtual key representation.
+ *  The SDL virtual key representation.
  *
  *  Values of this type are used to represent keyboard keys using the current
  *  layout of the keyboard.  These values include Unicode values representing
@@ -327,7 +327,7 @@ typedef enum
 } SDL_KeyCode;
 
 /**
- * \brief Enumeration of valid key mods (possibly OR'd together).
+ * Enumeration of valid key mods (possibly OR'd together).
  */
 typedef enum
 {

+ 1 - 1
include/SDL3/SDL_loadso.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_loadso.h
  *
- *  \brief System dependent library loading routines
+ *  System dependent library loading routines
  *
  *  Some things to keep in mind:
  *  \li These functions only work on C function names.  Other languages may

+ 1 - 1
include/SDL3/SDL_locale.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_locale.h
  *
- *  \brief Include file for SDL locale services
+ *  Include file for SDL locale services
  */
 
 #ifndef SDL_locale_h

+ 4 - 4
include/SDL3/SDL_log.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_log.h
  *
- *  \brief Simple log messages with categories and priorities.
+ *  Simple log messages with categories and priorities.
  *
  *  By default logs are quiet, but if you're debugging SDL you might want:
  *
@@ -47,14 +47,14 @@ extern "C" {
 
 
 /**
- *  \brief The maximum size of a log message prior to SDL 2.0.24
+ *  The maximum size of a log message prior to SDL 2.0.24
  *
  *  As of 2.0.24 there is no limit to the length of SDL log messages.
  */
 #define SDL_MAX_LOG_MESSAGE 4096
 
 /**
- *  \brief The predefined log categories
+ *  The predefined log categories
  *
  *  By default the application category is enabled at the INFO level,
  *  the assert category is enabled at the WARN level, test is enabled
@@ -97,7 +97,7 @@ typedef enum
 } SDL_LogCategory;
 
 /**
- *  \brief The predefined log priorities
+ *  The predefined log priorities
  */
 typedef enum
 {

+ 1 - 1
include/SDL3/SDL_main.h

@@ -35,7 +35,7 @@
 /**
  *  \file SDL_main.h
  *
- *  \brief Redefine main() on some platforms so that it is called by SDL.
+ *  Redefine main() on some platforms so that it is called by SDL.
  */
 
 #ifndef SDL_MAIN_HANDLED

+ 2 - 2
include/SDL3/SDL_metal.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_metal.h
  *
- *  \brief Header file for functions to creating Metal layers and views on SDL windows.
+ *  Header file for functions to creating Metal layers and views on SDL windows.
  */
 
 #ifndef SDL_metal_h_
@@ -37,7 +37,7 @@ extern "C" {
 #endif
 
 /**
- *  \brief A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
+ *  A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
  *
  *  \note This can be cast directly to an NSView or UIView.
  */

+ 1 - 1
include/SDL3/SDL_misc.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_misc.h
  *
- *  \brief Include file for SDL API functions that don't fit elsewhere.
+ *  Include file for SDL API functions that don't fit elsewhere.
  */
 
 #ifndef SDL_misc_h_

+ 3 - 3
include/SDL3/SDL_mouse.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_mouse.h
  *
- *  \brief Include file for SDL mouse event handling.
+ *  Include file for SDL mouse event handling.
  */
 
 #ifndef SDL_mouse_h_
@@ -43,7 +43,7 @@ typedef Uint32 SDL_MouseID;
 typedef struct SDL_Cursor SDL_Cursor;   /**< Implementation dependent */
 
 /**
- * \brief Cursor types for SDL_CreateSystemCursor().
+ * Cursor types for SDL_CreateSystemCursor().
  */
 typedef enum
 {
@@ -63,7 +63,7 @@ typedef enum
 } SDL_SystemCursor;
 
 /**
- * \brief Scroll direction types for the Scroll event
+ * Scroll direction types for the Scroll event
  */
 typedef enum
 {

+ 1 - 1
include/SDL3/SDL_mutex.h

@@ -25,7 +25,7 @@
 /**
  *  \file SDL_mutex.h
  *
- *  \brief Functions to provide thread synchronization primitives.
+ *  Functions to provide thread synchronization primitives.
  */
 
 #include <SDL3/SDL_stdinc.h>

+ 1 - 1
include/SDL3/SDL_oldnames.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_oldnames.h
  *
- *  \brief Definitions to ease transition from SDL2 code
+ *  Definitions to ease transition from SDL2 code
  */
 
 #ifndef SDL_oldnames_h_

+ 1 - 1
include/SDL3/SDL_opengl.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_opengl.h
  *
- *  \brief This is a simple file to encapsulate the OpenGL API headers.
+ *  This is a simple file to encapsulate the OpenGL API headers.
  */
 
 /**

+ 1 - 1
include/SDL3/SDL_opengles.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_opengles.h
  *
- *  \brief This is a simple file to encapsulate the OpenGL ES 1.X API headers.
+ *  This is a simple file to encapsulate the OpenGL ES 1.X API headers.
  */
 #include <SDL3/SDL_platform_defines.h>
 

+ 1 - 1
include/SDL3/SDL_opengles2.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_opengles2.h
  *
- *  \brief This is a simple file to encapsulate the OpenGL ES 2.0 API headers.
+ *  This is a simple file to encapsulate the OpenGL ES 2.0 API headers.
  */
 #include <SDL3/SDL_platform_defines.h>
 

+ 1 - 1
include/SDL3/SDL_pixels.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_pixels.h
  *
- *  \brief Header for the enumerated pixel format definitions.
+ *  Header for the enumerated pixel format definitions.
  *
  *  SDL's pixel formats have the following naming convention:
  *

+ 1 - 1
include/SDL3/SDL_platform.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_platform.h
  *
- *  \brief Header file for platform functions.
+ *  Header file for platform functions.
  */
 
 #ifndef SDL_platform_h_

+ 1 - 1
include/SDL3/SDL_platform_defines.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_platform_defines.h
  *
- *  \brief Try to get a standard set of platform defines.
+ *  Try to get a standard set of platform defines.
  */
 
 #ifndef SDL_platform_defines_h_

+ 1 - 1
include/SDL3/SDL_power.h

@@ -25,7 +25,7 @@
 /**
  *  \file SDL_power.h
  *
- *  \brief Header for the SDL power management routines.
+ *  Header for the SDL power management routines.
  */
 
 #include <SDL3/SDL_stdinc.h>

+ 1 - 1
include/SDL3/SDL_properties.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_properties.h
  *
- *  \brief Header file for SDL properties.
+ *  Header file for SDL properties.
  */
 
 #ifndef SDL_properties_h_

+ 1 - 1
include/SDL3/SDL_quit.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_quit.h
  *
- *  \brief Include file for SDL quit event handling.
+ *  Include file for SDL quit event handling.
  */
 
 #ifndef SDL_quit_h_

+ 1 - 1
include/SDL3/SDL_rect.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_rect.h
  *
- *  \brief Header file for SDL_rect definition and management functions.
+ *  Header file for SDL_rect definition and management functions.
  */
 
 #ifndef SDL_rect_h_

+ 1 - 1
include/SDL3/SDL_render.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_render.h
  *
- *  \brief Header file for SDL 2D rendering functions.
+ *  Header file for SDL 2D rendering functions.
  *
  *  This API supports the following features:
  *      * single pixel points

+ 1 - 1
include/SDL3/SDL_revision.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_revision.h
  *
- *  \brief Header file containing the SDL revision
+ *  Header file containing the SDL revision
  */
 
 #ifndef SDL_revision_h_

+ 2 - 2
include/SDL3/SDL_scancode.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_scancode.h
  *
- *  \brief Defines keyboard scancodes.
+ *  Defines keyboard scancodes.
  */
 
 #ifndef SDL_scancode_h_
@@ -31,7 +31,7 @@
 #include <SDL3/SDL_stdinc.h>
 
 /**
- *  \brief The SDL keyboard scancode representation.
+ *  The SDL keyboard scancode representation.
  *
  *  Values of this type are used to represent keyboard keys, among other places
  *  in the \link SDL_Keysym::scancode key.keysym.scancode \endlink field of the

+ 2 - 2
include/SDL3/SDL_sensor.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_sensor.h
  *
- *  \brief Include file for SDL sensor event handling
+ *  Include file for SDL sensor event handling
  */
 
 #ifndef SDL_sensor_h_
@@ -41,7 +41,7 @@ extern "C" {
 #endif
 
 /**
- *  \brief SDL_sensor.h
+ *  SDL_sensor.h
  *
  *  In order to use these functions, SDL_Init() must have been called
  *  with the ::SDL_INIT_SENSOR flag.  This causes SDL to scan the system

+ 11 - 11
include/SDL3/SDL_shape.h

@@ -36,7 +36,7 @@ extern "C" {
 
 /** \file SDL_shape.h
  *
- *  \brief Header file for the shaped window API.
+ *  Header file for the shaped window API.
  */
 
 #define SDL_NONSHAPEABLE_WINDOW -1
@@ -76,32 +76,32 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_CreateShapedWindow(const char *title, in
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window);
 
-/** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
+/** An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
 typedef enum {
-    /** \brief The default mode, a binarized alpha cutoff of 1. */
+    /** The default mode, a binarized alpha cutoff of 1. */
     ShapeModeDefault,
-    /** \brief A binarized alpha cutoff with a given integer value. */
+    /** A binarized alpha cutoff with a given integer value. */
     ShapeModeBinarizeAlpha,
-    /** \brief A binarized alpha cutoff with a given integer value, but with the opposite comparison. */
+    /** A binarized alpha cutoff with a given integer value, but with the opposite comparison. */
     ShapeModeReverseBinarizeAlpha,
-    /** \brief A color key is applied. */
+    /** A color key is applied. */
     ShapeModeColorKey
 } WindowShapeMode;
 
 #define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha)
 
-/** \brief A union containing parameters for shaped windows. */
+/** A union containing parameters for shaped windows. */
 typedef union {
-    /** \brief A cutoff alpha value for binarization of the window shape's alpha channel. */
+    /** A cutoff alpha value for binarization of the window shape's alpha channel. */
     Uint8 binarizationCutoff;
     SDL_Color colorKey;
 } SDL_WindowShapeParams;
 
-/** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
+/** A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
 typedef struct SDL_WindowShapeMode {
-    /** \brief The mode of these window-shape parameters. */
+    /** The mode of these window-shape parameters. */
     WindowShapeMode mode;
-    /** \brief Window-shape parameters. */
+    /** Window-shape parameters. */
     SDL_WindowShapeParams parameters;
 } SDL_WindowShapeMode;
 

+ 10 - 10
include/SDL3/SDL_stdinc.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_stdinc.h
  *
- *  \brief This is a general header that includes C language support.
+ *  This is a general header that includes C language support.
  */
 
 #ifndef SDL_stdinc_h_
@@ -123,57 +123,57 @@ char *alloca();
 /* @{ */
 
 /**
- * \brief A boolean type.
+ * A boolean type.
  */
 #define SDL_FALSE 0
 #define SDL_TRUE 1
 typedef unsigned int SDL_bool;
 
 /**
- * \brief A signed 8-bit integer type.
+ * A signed 8-bit integer type.
  */
 #define SDL_MAX_SINT8   ((Sint8)0x7F)           /* 127 */
 #define SDL_MIN_SINT8   ((Sint8)(~0x7F))        /* -128 */
 typedef int8_t Sint8;
 /**
- * \brief An unsigned 8-bit integer type.
+ * An unsigned 8-bit integer type.
  */
 #define SDL_MAX_UINT8   ((Uint8)0xFF)           /* 255 */
 #define SDL_MIN_UINT8   ((Uint8)0x00)           /* 0 */
 typedef uint8_t Uint8;
 /**
- * \brief A signed 16-bit integer type.
+ * A signed 16-bit integer type.
  */
 #define SDL_MAX_SINT16  ((Sint16)0x7FFF)        /* 32767 */
 #define SDL_MIN_SINT16  ((Sint16)(~0x7FFF))     /* -32768 */
 typedef int16_t Sint16;
 /**
- * \brief An unsigned 16-bit integer type.
+ * An unsigned 16-bit integer type.
  */
 #define SDL_MAX_UINT16  ((Uint16)0xFFFF)        /* 65535 */
 #define SDL_MIN_UINT16  ((Uint16)0x0000)        /* 0 */
 typedef uint16_t Uint16;
 /**
- * \brief A signed 32-bit integer type.
+ * A signed 32-bit integer type.
  */
 #define SDL_MAX_SINT32  ((Sint32)0x7FFFFFFF)    /* 2147483647 */
 #define SDL_MIN_SINT32  ((Sint32)(~0x7FFFFFFF)) /* -2147483648 */
 typedef int32_t Sint32;
 /**
- * \brief An unsigned 32-bit integer type.
+ * An unsigned 32-bit integer type.
  */
 #define SDL_MAX_UINT32  ((Uint32)0xFFFFFFFFu)   /* 4294967295 */
 #define SDL_MIN_UINT32  ((Uint32)0x00000000)    /* 0 */
 typedef uint32_t Uint32;
 
 /**
- * \brief A signed 64-bit integer type.
+ * A signed 64-bit integer type.
  */
 #define SDL_MAX_SINT64  ((Sint64)0x7FFFFFFFFFFFFFFFll)      /* 9223372036854775807 */
 #define SDL_MIN_SINT64  ((Sint64)(~0x7FFFFFFFFFFFFFFFll))   /* -9223372036854775808 */
 typedef int64_t Sint64;
 /**
- * \brief An unsigned 64-bit integer type.
+ * An unsigned 64-bit integer type.
  */
 #define SDL_MAX_UINT64  ((Uint64)0xFFFFFFFFFFFFFFFFull)     /* 18446744073709551615 */
 #define SDL_MIN_UINT64  ((Uint64)(0x0000000000000000ull))   /* 0 */

+ 4 - 4
include/SDL3/SDL_surface.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_surface.h
  *
- *  \brief Header file for ::SDL_Surface definition and management functions.
+ *  Header file for ::SDL_Surface definition and management functions.
  */
 
 #ifndef SDL_surface_h_
@@ -65,7 +65,7 @@ extern "C" {
 typedef struct SDL_BlitMap SDL_BlitMap;  /* this is an opaque type. */
 
 /**
- * \brief A collection of pixels used in software blitting.
+ * A collection of pixels used in software blitting.
  *
  * Pixels are arranged in memory in rows, with the top row first.
  * Each row occupies an amount of memory given by the pitch (sometimes
@@ -112,13 +112,13 @@ typedef struct SDL_Surface
 } SDL_Surface;
 
 /**
- * \brief The type of function used for surface blitting functions.
+ * The type of function used for surface blitting functions.
  */
 typedef int (SDLCALL *SDL_blit) (struct SDL_Surface *src, const SDL_Rect *srcrect,
                                  struct SDL_Surface *dst, const SDL_Rect *dstrect);
 
 /**
- * \brief The formula used for converting between YUV and RGB
+ * The formula used for converting between YUV and RGB
  */
 typedef enum
 {

+ 11 - 11
include/SDL3/SDL_system.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_system.h
  *
- *  \brief Include file for platform specific SDL API functions
+ *  Include file for platform specific SDL API functions
  */
 
 #ifndef SDL_system_h_
@@ -475,44 +475,44 @@ extern DECLSPEC int SDLCALL SDL_AndroidSendMessage(Uint32 command, int param);
 #ifdef __WINRT__
 
 /**
- *  \brief WinRT / Windows Phone path types
+ *  WinRT / Windows Phone path types
  */
 typedef enum
 {
-    /** \brief The installed app's root directory.
+    /** The installed app's root directory.
         Files here are likely to be read-only. */
     SDL_WINRT_PATH_INSTALLED_LOCATION,
 
-    /** \brief The app's local data store.  Files may be written here */
+    /** The app's local data store.  Files may be written here */
     SDL_WINRT_PATH_LOCAL_FOLDER,
 
-    /** \brief The app's roaming data store.  Unsupported on Windows Phone.
+    /** The app's roaming data store.  Unsupported on Windows Phone.
         Files written here may be copied to other machines via a network
         connection.
     */
     SDL_WINRT_PATH_ROAMING_FOLDER,
 
-    /** \brief The app's temporary data store.  Unsupported on Windows Phone.
+    /** The app's temporary data store.  Unsupported on Windows Phone.
         Files written here may be deleted at any time. */
     SDL_WINRT_PATH_TEMP_FOLDER
 } SDL_WinRT_Path;
 
 
 /**
- *  \brief WinRT Device Family
+ *  WinRT Device Family
  */
 typedef enum
 {
-    /** \brief Unknown family  */
+    /** Unknown family  */
     SDL_WINRT_DEVICEFAMILY_UNKNOWN,
 
-    /** \brief Desktop family*/
+    /** Desktop family*/
     SDL_WINRT_DEVICEFAMILY_DESKTOP,
 
-    /** \brief Mobile family (for example smartphone) */
+    /** Mobile family (for example smartphone) */
     SDL_WINRT_DEVICEFAMILY_MOBILE,
 
-    /** \brief XBox family */
+    /** XBox family */
     SDL_WINRT_DEVICEFAMILY_XBOX,
 } SDL_WinRT_DeviceFamily;
 

+ 2 - 2
include/SDL3/SDL_syswm.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_syswm.h
  *
- *  \brief Include file for SDL custom system window manager hooks.
+ *  Include file for SDL custom system window manager hooks.
  */
 
 #ifndef SDL_syswm_h_
@@ -34,7 +34,7 @@
 #include <SDL3/SDL_video.h>
 
 /**
- *  \brief SDL_syswm.h
+ *  SDL_syswm.h
  *
  *  Your application has access to a special type of event ::SDL_EVENT_SYSWM,
  *  which contains window-manager specific information and arrives whenever

+ 1 - 1
include/SDL3/SDL_test.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test.h
  *
- *  \brief Include file for SDL test framework.
+ *  Include file for SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */

+ 9 - 9
include/SDL3/SDL_test_assert.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_assert.h
  *
- *  \brief Assertion functions of SDL test framework.
+ *  Assertion functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -43,17 +43,17 @@ extern "C" {
 #endif
 
 /**
- * \brief Fails the assert.
+ * Fails the assert.
  */
 #define ASSERT_FAIL     0
 
 /**
- * \brief Passes the assert.
+ * Passes the assert.
  */
 #define ASSERT_PASS     1
 
 /**
- * \brief Assert that logs and break execution flow on failures.
+ * Assert that logs and break execution flow on failures.
  *
  * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
  * \param assertDescription Message to log with the assert describing it.
@@ -61,7 +61,7 @@ extern "C" {
 void SDLTest_Assert(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2);
 
 /**
- * \brief Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters.
+ * Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters.
  *
  * \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
  * \param assertDescription Message to log with the assert describing it.
@@ -71,25 +71,25 @@ void SDLTest_Assert(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *as
 int SDLTest_AssertCheck(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2);
 
 /**
- * \brief Explicitly pass without checking an assertion condition. Updates assertion counter.
+ * Explicitly pass without checking an assertion condition. Updates assertion counter.
  *
  * \param assertDescription Message to log with the assert describing it.
  */
 void SDLTest_AssertPass(SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(1);
 
 /**
- * \brief Resets the assert summary counters to zero.
+ * Resets the assert summary counters to zero.
  */
 void SDLTest_ResetAssertSummary(void);
 
 /**
- * \brief Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR.
+ * Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR.
  */
 void SDLTest_LogAssertSummary(void);
 
 
 /**
- * \brief Converts the current assert summary state to a test result.
+ * Converts the current assert summary state to a test result.
  *
  * \returns TEST_RESULT_PASSED, TEST_RESULT_FAILED, or TEST_RESULT_NO_ASSERT
  */

+ 9 - 9
include/SDL3/SDL_test_common.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_common.h
  *
- *  \brief Common functions of SDL test framework.
+ *  Common functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -139,7 +139,7 @@ extern "C" {
 /* Function prototypes */
 
 /**
- * \brief Parse command line parameters and create common state.
+ * Parse command line parameters and create common state.
  *
  * \param argv Array of command line parameters
  * \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
@@ -149,14 +149,14 @@ extern "C" {
 SDLTest_CommonState *SDLTest_CommonCreateState(char **argv, Uint32 flags);
 
 /**
- * \brief Free the common state object.
+ * Free the common state object.
  *
  * \param state The common state object to destroy
  */
 void SDLTest_CommonDestroyState(SDLTest_CommonState *state);
 
 /**
- * \brief Process one common argument.
+ * Process one common argument.
  *
  * \param state The common state describing the test window to create.
  * \param index The index of the argument to process in argv[].
@@ -167,7 +167,7 @@ int SDLTest_CommonArg(SDLTest_CommonState *state, int index);
 
 
 /**
- * \brief Logs command line usage info.
+ * Logs command line usage info.
  *
  * This logs the appropriate command line options for the subsystems in use
  *  plus other common options, and then any application-specific options.
@@ -181,7 +181,7 @@ int SDLTest_CommonArg(SDLTest_CommonState *state, int index);
 void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options);
 
 /**
- * \brief Open test window.
+ * Open test window.
  *
  * \param state The common state describing the test window to create.
  *
@@ -190,7 +190,7 @@ void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const
 SDL_bool SDLTest_CommonInit(SDLTest_CommonState *state);
 
 /**
- * \brief Easy argument handling when test app doesn't need any custom args.
+ * Easy argument handling when test app doesn't need any custom args.
  *
  * \param state The common state describing the test window to create.
  * \param argc argc, as supplied to SDL_main
@@ -223,7 +223,7 @@ void SDLTest_CommonEvent(SDLTest_CommonState *state, SDL_Event *event, int *done
 int SDLTest_CommonEventMainCallbacks(SDLTest_CommonState *state, const SDL_Event *event);
 
 /**
- * \brief Close test window.
+ * Close test window.
  *
  * \param state The common state used to create test window.
  *
@@ -231,7 +231,7 @@ int SDLTest_CommonEventMainCallbacks(SDLTest_CommonState *state, const SDL_Event
 void SDLTest_CommonQuit(SDLTest_CommonState *state);
 
 /**
- * \brief Draws various window information (position, size, etc.) to the renderer.
+ * Draws various window information (position, size, etc.) to the renderer.
  *
  * \param renderer The renderer to draw to.
  * \param window The window whose information should be displayed.

+ 3 - 3
include/SDL3/SDL_test_compare.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_compare.h
  *
- *  \brief Comparison function of SDL test framework.
+ *  Comparison function of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -45,7 +45,7 @@ extern "C" {
 #endif
 
 /**
- * \brief Retrieves a single pixel from a surface.
+ * Retrieves a single pixel from a surface.
  *
  * This function prioritizes correctness over speed: it is suitable for
  * unit tests, but is not intended for use in a game engine.
@@ -66,7 +66,7 @@ extern "C" {
 int SDLTest_ReadSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);
 
 /**
- * \brief Compares a surface and with reference image data for equality
+ * Compares a surface and with reference image data for equality
  *
  * \param surface Surface used in comparison
  * \param referenceSurface Test Surface used in comparison

+ 4 - 4
include/SDL3/SDL_test_crc32.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_crc32.h
  *
- *  \brief CRC32 functions of SDL test framework.
+ *  CRC32 functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -70,7 +70,7 @@ extern "C" {
 /* ---------- Function Prototypes ------------- */
 
 /**
- * \brief Initialize the CRC context
+ * Initialize the CRC context
  *
  * Note: The function initializes the crc table required for all crc calculations.
  *
@@ -83,7 +83,7 @@ extern "C" {
 
 
 /**
- * \brief calculate a crc32 from a data block
+ * calculate a crc32 from a data block
  *
  * \param crcContext         pointer to context variable
  * \param inBuf              input buffer to checksum
@@ -102,7 +102,7 @@ int SDLTest_Crc32CalcBuffer(SDLTest_Crc32Context *crcContext, CrcUint8 *inBuf, C
 
 
 /**
- * \brief clean up CRC context
+ * clean up CRC context
  *
  * \param crcContext        pointer to context variable
  *

+ 11 - 11
include/SDL3/SDL_test_font.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_font.h
  *
- *  \brief Font related functions of SDL test framework.
+ *  Font related functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -43,7 +43,7 @@ extern int FONT_CHARACTER_SIZE;
 #define FONT_LINE_HEIGHT    (FONT_CHARACTER_SIZE + 2)
 
 /**
- *  \brief Draw a string in the currently set font.
+ *  Draw a string in the currently set font.
  *
  *  \param renderer The renderer to draw on.
  *  \param x The X coordinate of the upper left corner of the character.
@@ -55,7 +55,7 @@ extern int FONT_CHARACTER_SIZE;
 int SDLTest_DrawCharacter(SDL_Renderer *renderer, float x, float y, Uint32 c);
 
 /**
- *  \brief Draw a UTF-8 string in the currently set font.
+ *  Draw a UTF-8 string in the currently set font.
  *
  *  The font currently only supports characters in the Basic Latin and Latin-1 Supplement sets.
  *
@@ -69,7 +69,7 @@ int SDLTest_DrawCharacter(SDL_Renderer *renderer, float x, float y, Uint32 c);
 int SDLTest_DrawString(SDL_Renderer *renderer, float x, float y, const char *s);
 
 /**
- *  \brief Data used for multi-line text output
+ *  Data used for multi-line text output
  */
 typedef struct SDLTest_TextWindow
 {
@@ -80,7 +80,7 @@ typedef struct SDLTest_TextWindow
 } SDLTest_TextWindow;
 
 /**
- *  \brief Create a multi-line text output window
+ *  Create a multi-line text output window
  *
  *  \param x The X coordinate of the upper left corner of the window.
  *  \param y The Y coordinate of the upper left corner of the window.
@@ -94,7 +94,7 @@ typedef struct SDLTest_TextWindow
 SDLTest_TextWindow *SDLTest_TextWindowCreate(float x, float y, float w, float h);
 
 /**
- *  \brief Display a multi-line text output window
+ *  Display a multi-line text output window
  *
  *  This function should be called every frame to display the text
  *
@@ -106,7 +106,7 @@ SDLTest_TextWindow *SDLTest_TextWindowCreate(float x, float y, float w, float h)
 void SDLTest_TextWindowDisplay(SDLTest_TextWindow *textwin, SDL_Renderer *renderer);
 
 /**
- *  \brief Add text to a multi-line text output window
+ *  Add text to a multi-line text output window
  *
  *  Adds UTF-8 text to the end of the current text. The newline character starts a
  *  new line of text. The backspace character deletes the last character or, if the
@@ -121,7 +121,7 @@ void SDLTest_TextWindowDisplay(SDLTest_TextWindow *textwin, SDL_Renderer *render
 void SDLTest_TextWindowAddText(SDLTest_TextWindow *textwin, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2);
 
 /**
- *  \brief Add text to a multi-line text output window
+ *  Add text to a multi-line text output window
  *
  *  Adds UTF-8 text to the end of the current text. The newline character starts a
  *  new line of text. The backspace character deletes the last character or, if the
@@ -136,7 +136,7 @@ void SDLTest_TextWindowAddText(SDLTest_TextWindow *textwin, SDL_PRINTF_FORMAT_ST
 void SDLTest_TextWindowAddTextWithLength(SDLTest_TextWindow *textwin, const char *text, size_t len);
 
 /**
- *  \brief Clear the text in a multi-line text output window
+ *  Clear the text in a multi-line text output window
  *
  *  \param textwin The text output window
  *
@@ -145,7 +145,7 @@ void SDLTest_TextWindowAddTextWithLength(SDLTest_TextWindow *textwin, const char
 void SDLTest_TextWindowClear(SDLTest_TextWindow *textwin);
 
 /**
- *  \brief Free the storage associated with a multi-line text output window
+ *  Free the storage associated with a multi-line text output window
  *
  *  \param textwin The text output window
  *
@@ -154,7 +154,7 @@ void SDLTest_TextWindowClear(SDLTest_TextWindow *textwin);
 void SDLTest_TextWindowDestroy(SDLTest_TextWindow *textwin);
 
 /**
- *  \brief Cleanup textures used by font drawing functions.
+ *  Cleanup textures used by font drawing functions.
  */
 void SDLTest_CleanupTextDrawing(void);
 

+ 1 - 1
include/SDL3/SDL_test_fuzzer.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_fuzzer.h
  *
- *  \brief Fuzzer functions of SDL test framework.
+ *  Fuzzer functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */

+ 3 - 3
include/SDL3/SDL_test_harness.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_harness.h
  *
- *  \brief Test suite related functions of SDL test framework.
+ *  Test suite related functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -99,7 +99,7 @@ typedef struct SDLTest_TestSuiteReference {
 
 
 /**
- * \brief Generates a random run seed string for the harness. The generated seed will contain alphanumeric characters (0-9A-Z).
+ * Generates a random run seed string for the harness. The generated seed will contain alphanumeric characters (0-9A-Z).
  *
  * Note: The returned string needs to be deallocated by the caller.
  *
@@ -110,7 +110,7 @@ typedef struct SDLTest_TestSuiteReference {
 char *SDLTest_GenerateRunSeed(const int length);
 
 /**
- * \brief Execute a test suite using the given run seed and execution key.
+ * Execute a test suite using the given run seed and execution key.
  *
  * \param testSuites Suites containing the test case.
  * \param userRunSeed Custom run seed provided by user, or NULL to autogenerate one.

+ 3 - 3
include/SDL3/SDL_test_log.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_log.h
  *
- *  \brief Logging related functions of SDL test framework.
+ *  Logging related functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -43,14 +43,14 @@ extern "C" {
 #endif
 
 /**
- * \brief Prints given message with a timestamp in the TEST category and INFO priority.
+ * Prints given message with a timestamp in the TEST category and INFO priority.
  *
  * \param fmt Message to be logged
  */
 void SDLTest_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
 
 /**
- * \brief Prints given message with a timestamp in the TEST category and the ERROR priority.
+ * Prints given message with a timestamp in the TEST category and the ERROR priority.
  *
  * \param fmt Message to be logged
  */

+ 4 - 4
include/SDL3/SDL_test_md5.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_md5.h
  *
- *  \brief MD5 related functions of SDL test framework.
+ *  MD5 related functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -78,7 +78,7 @@ extern "C" {
 /* ---------- Function Prototypes ------------- */
 
 /**
- * \brief initialize the context
+ * initialize the context
  *
  * \param  mdContext        pointer to context variable
  *
@@ -90,7 +90,7 @@ extern "C" {
 
 
 /**
- * \brief update digest from variable length data
+ * update digest from variable length data
  *
  * \param  mdContext       pointer to context variable
  * \param  inBuf           pointer to data array/string
@@ -106,7 +106,7 @@ extern "C" {
 
 
 /**
- * \brief complete digest computation
+ * complete digest computation
  *
  * \param mdContext     pointer to context variable
  *

+ 4 - 4
include/SDL3/SDL_test_memory.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_memory.h
  *
- *  \brief Memory tracking related functions of SDL test framework.
+ *  Memory tracking related functions of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -38,21 +38,21 @@ extern "C" {
 
 
 /**
- * \brief Start tracking SDL memory allocations
+ * Start tracking SDL memory allocations
  *
  * \note This should be called before any other SDL functions for complete tracking coverage
  */
 void SDLTest_TrackAllocations(void);
 
 /**
- * \brief Fill allocations with random data
+ * Fill allocations with random data
  *
  * \note This implicitly calls SDLTest_TrackAllocations()
  */
 void SDLTest_RandFillAllocations();
 
 /**
- * \brief Print a log of any outstanding allocations
+ * Print a log of any outstanding allocations
  *
  * \note This can be called after SDL_Quit()
  */

+ 4 - 4
include/SDL3/SDL_test_random.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_test_random.h
  *
- *  \brief Random number generator related function of SDL test framework.
+ *  Random number generator related function of SDL test framework.
  *
  *  This code is a part of the SDL test library, not the main SDL library.
  */
@@ -68,7 +68,7 @@ extern "C" {
 /* --- Function prototypes */
 
 /**
- *  \brief Initialize random number generator with two integers.
+ *  Initialize random number generator with two integers.
  *
  *  Note: The random sequence of numbers returned by ...Random() is the
  *  same for the same two integers and has a period of 2^31.
@@ -81,7 +81,7 @@ extern "C" {
  void SDLTest_RandomInit(SDLTest_RandomContext *rndContext, unsigned int xi, unsigned int ci);
 
 /**
- *  \brief Initialize random number generator based on current system time.
+ *  Initialize random number generator based on current system time.
  *
  *  \param rndContext     pointer to context structure
  *
@@ -90,7 +90,7 @@ extern "C" {
 
 
 /**
- *  \brief Initialize random number generator based on current system time.
+ *  Initialize random number generator based on current system time.
  *
  *  Note: ...RandomInit() or ...RandomInitTime() must have been called
  *  before using this function.

+ 1 - 1
include/SDL3/SDL_thread.h

@@ -25,7 +25,7 @@
 /**
  *  \file SDL_thread.h
  *
- *  \brief Header for the SDL thread management routines.
+ *  Header for the SDL thread management routines.
  */
 
 #include <SDL3/SDL_stdinc.h>

+ 1 - 1
include/SDL3/SDL_timer.h

@@ -25,7 +25,7 @@
 /**
  *  \file SDL_timer.h
  *
- *  \brief Header for the SDL time management routines.
+ *  Header for the SDL time management routines.
  */
 
 #include <SDL3/SDL_stdinc.h>

+ 1 - 1
include/SDL3/SDL_touch.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_touch.h
  *
- *  \brief Include file for SDL touch event handling.
+ *  Include file for SDL touch event handling.
  */
 
 #ifndef SDL_touch_h_

+ 1 - 1
include/SDL3/SDL_version.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_version.h
  *
- *  \brief This header defines the current SDL version.
+ *  This header defines the current SDL version.
  */
 
 #ifndef SDL_version_h_

+ 13 - 13
include/SDL3/SDL_video.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_video.h
  *
- *  \brief Header file for SDL video functions.
+ *  Header file for SDL video functions.
  */
 
 #ifndef SDL_video_h_
@@ -45,7 +45,7 @@ typedef Uint32 SDL_DisplayID;
 typedef Uint32 SDL_WindowID;
 
 /**
- *  \brief System theme
+ *  System theme
  */
 typedef enum
 {
@@ -55,7 +55,7 @@ typedef enum
 } SDL_SystemTheme;
 
 /**
- *  \brief  The structure that defines a display mode
+ *  The structure that defines a display mode
  *
  *  \sa SDL_GetFullscreenDisplayModes()
  *  \sa SDL_GetDesktopDisplayMode()
@@ -75,7 +75,7 @@ typedef struct
 } SDL_DisplayMode;
 
 /**
- *  \brief Display orientation
+ *  Display orientation
  */
 typedef enum
 {
@@ -87,7 +87,7 @@ typedef enum
 } SDL_DisplayOrientation;
 
 /**
- *  \brief The type used to identify a window
+ *  The type used to identify a window
  *
  *  \sa SDL_CreateWindow()
  *  \sa SDL_CreateWindowFrom()
@@ -122,7 +122,7 @@ typedef enum
 typedef struct SDL_Window SDL_Window;
 
 /**
- *  \brief The flags on a window
+ *  The flags on a window
  *
  *  \sa SDL_GetWindowFlags()
  */
@@ -155,7 +155,7 @@ typedef enum
 } SDL_WindowFlags;
 
 /**
- *  \brief Used to indicate that you don't care what the window position is.
+ *  Used to indicate that you don't care what the window position is.
  */
 #define SDL_WINDOWPOS_UNDEFINED_MASK    0x1FFF0000u
 #define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X)  (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
@@ -164,7 +164,7 @@ typedef enum
             (((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
 
 /**
- *  \brief Used to indicate that the window position should be centered.
+ *  Used to indicate that the window position should be centered.
  */
 #define SDL_WINDOWPOS_CENTERED_MASK    0x2FFF0000u
 #define SDL_WINDOWPOS_CENTERED_DISPLAY(X)  (SDL_WINDOWPOS_CENTERED_MASK|(X))
@@ -173,7 +173,7 @@ typedef enum
             (((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
 
 /**
- *  \brief Window flash operation
+ *  Window flash operation
  */
 typedef enum
 {
@@ -183,12 +183,12 @@ typedef enum
 } SDL_FlashOperation;
 
 /**
- *  \brief An opaque handle to an OpenGL context.
+ *  An opaque handle to an OpenGL context.
  */
 typedef void *SDL_GLContext;
 
 /**
- *  \brief Opaque EGL types.
+ *  Opaque EGL types.
  */
 typedef void *SDL_EGLDisplay;
 typedef void *SDL_EGLConfig;
@@ -197,13 +197,13 @@ typedef intptr_t SDL_EGLAttrib;
 typedef int SDL_EGLint;
 
 /**
- *  \brief EGL attribute initialization callback types.
+ *  EGL attribute initialization callback types.
  */
 typedef SDL_EGLAttrib *(SDLCALL *SDL_EGLAttribArrayCallback)(void);
 typedef SDL_EGLint *(SDLCALL *SDL_EGLIntArrayCallback)(void);
 
 /**
- *  \brief OpenGL configuration attributes
+ *  OpenGL configuration attributes
  */
 typedef enum
 {

+ 1 - 1
include/SDL3/SDL_vulkan.h

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_vulkan.h
  *
- *  \brief Header file for functions to creating Vulkan surfaces on SDL windows.
+ *  Header file for functions to creating Vulkan surfaces on SDL windows.
  */
 
 #ifndef SDL_vulkan_h_

+ 1 - 1
include/build_config/SDL_build_config.h

@@ -27,7 +27,7 @@
 /**
  *  \file SDL_build_config.h
  *
- *  \brief This is a set of defines to configure the SDL features
+ *  This is a set of defines to configure the SDL features
  */
 
 /* Add any platform that doesn't build using the configure system. */

+ 1 - 1
include/build_config/SDL_build_config.h.cmake

@@ -22,7 +22,7 @@
 /**
  *  \file SDL_build_config.h
  *
- *  \brief This is a set of defines to configure the SDL features
+ *  This is a set of defines to configure the SDL features
  */
 
 #ifndef SDL_build_config_h_

+ 1 - 1
include/build_config/SDL_revision.h.cmake

@@ -22,7 +22,7 @@
 /**
 *  \file SDL_revision.h
 *
-*  \brief Header file containing the SDL revision.
+*  Header file containing the SDL revision.
 */
 
 #ifndef SDL_revision_h_

+ 1 - 1
src/core/linux/SDL_udev.h

@@ -35,7 +35,7 @@
 #include <sys/types.h>
 
 /**
- *  \brief Device type
+ *  Device type
  */
 
 typedef enum

+ 1 - 1
src/hidapi/doxygen/Doxyfile

@@ -214,7 +214,7 @@ JAVADOC_BANNER         = NO
 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
 # line (until the first dot) of a Qt-style comment as the brief description. If
 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
-# requiring an explicit \brief command for a brief description.)
+# requiring an explicit command for a brief description.)
 # The default value is: NO.
 
 QT_AUTOBRIEF           = NO

+ 8 - 8
src/render/software/SDL_rotate.c

@@ -44,7 +44,7 @@ Andreas Schiffler -- aschiffler at ferzkopp dot net
 /* ---- Internally used structures */
 
 /**
-\brief A 32 bit RGBA pixel.
+A 32 bit RGBA pixel.
 */
 typedef struct tColorRGBA
 {
@@ -55,7 +55,7 @@ typedef struct tColorRGBA
 } tColorRGBA;
 
 /**
-\brief A 8bit Y/palette pixel.
+A 8bit Y/palette pixel.
 */
 typedef struct tColorY
 {
@@ -63,7 +63,7 @@ typedef struct tColorY
 } tColorY;
 
 /**
-\brief Number of guard rows added to destination surfaces.
+Number of guard rows added to destination surfaces.
 
 This is a simple but effective workaround for observed issues.
 These rows allocate extra memory and are then hidden from the surface.
@@ -75,7 +75,7 @@ to a situation where the program can segfault.
 #define GUARD_ROWS (2)
 
 /**
-\brief Returns colorkey info for a surface
+Returns colorkey info for a surface
 */
 static Uint32 get_colorkey(SDL_Surface *src)
 {
@@ -100,7 +100,7 @@ static void rotate(double sx, double sy, double sinangle, double cosangle, const
 }
 
 /**
-\brief Internal target surface sizing function for rotations with trig result return.
+Internal target surface sizing function for rotations with trig result return.
 
 \param width The source surface width.
 \param height The source surface height.
@@ -249,7 +249,7 @@ static void transformSurfaceY90(SDL_Surface *src, SDL_Surface *dst, int angle, i
 #undef TRANSFORM_SURFACE_90
 
 /**
-\brief Internal 32 bit rotozoomer with optional anti-aliasing.
+Internal 32 bit rotozoomer with optional anti-aliasing.
 
 Rotates and zooms 32 bit RGBA/ABGR 'src' surface to 'dst' surface based on the control
 parameters by scanning the destination surface and applying optionally anti-aliasing
@@ -391,7 +391,7 @@ static void transformSurfaceRGBA(SDL_Surface *src, SDL_Surface *dst, int isin, i
 
 /**
 
-\brief Rotates and zooms 8 bit palette/Y 'src' surface to 'dst' surface without smoothing.
+Rotates and zooms 8 bit palette/Y 'src' surface to 'dst' surface without smoothing.
 
 Rotates and zooms 8 bit RGBA/ABGR 'src' surface to 'dst' surface based on the control
 parameters by scanning the destination surface.
@@ -462,7 +462,7 @@ static void transformSurfaceY(SDL_Surface *src, SDL_Surface *dst, int isin, int
 }
 
 /**
-\brief Rotates and zooms a surface with different horizontal and vertival scaling factors and optional anti-aliasing.
+Rotates and zooms a surface with different horizontal and vertival scaling factors and optional anti-aliasing.
 
 Rotates a 32-bit or 8-bit 'src' surface to newly created 'dst' surface.
 'angle' is the rotation in degrees, 'center' the rotation center. If 'smooth' is set

+ 2 - 2
src/test/SDL_test_assert.c

@@ -48,10 +48,10 @@
 #define SDLTEST_ASSERT_SUMMARY_FORMAT    "Assert Summary: Total=%d " COLOR_GREEN "Passed=%d" COLOR_END " " COLOR_RED "Failed=%d" COLOR_END
 #define SDLTEST_ASSERT_SUMMARY_FORMAT_OK "Assert Summary: Total=%d " COLOR_GREEN "Passed=%d" COLOR_END " " COLOR_GREEN "Failed=%d" COLOR_END
 
-/* ! \brief counts the failed asserts */
+/* ! counts the failed asserts */
 static int SDLTest_AssertsFailed = 0;
 
-/* ! \brief counts the passed asserts */
+/* ! counts the passed asserts */
 static int SDLTest_AssertsPassed = 0;
 
 /*

+ 1 - 1
src/test/SDL_test_font.c

@@ -3122,7 +3122,7 @@ struct SDLTest_CharTextureCache
 };
 
 /*!
-\brief List of per-renderer caches for 8x8 pixel font textures created at runtime.
+List of per-renderer caches for 8x8 pixel font textures created at runtime.
 */
 static struct SDLTest_CharTextureCache *SDLTest_CharTextureCacheList;
 

+ 5 - 5
src/test/SDL_test_harness.c

@@ -47,7 +47,7 @@
 /* Final result message format */
 #define SDLTEST_FINAL_RESULT_FORMAT COLOR_YELLOW ">>> %s '%s':" COLOR_END " %s\n"
 
-/* ! \brief Timeout for single test case execution */
+/* ! Timeout for single test case execution */
 static Uint32 SDLTest_TestCaseTimeout = 3600;
 
 /**
@@ -167,7 +167,7 @@ static Uint64 SDLTest_GenerateExecKey(const char *runSeed, const char *suiteName
 }
 
 /**
- * \brief Set timeout handler for test.
+ * Set timeout handler for test.
  *
  * Note: SDL_Init(SDL_INIT_TIMER) will be called if it wasn't done so before.
  *
@@ -211,7 +211,7 @@ static SDL_TimerID SDLTest_SetTestTimeout(int timeout, void(SDLCALL *callback)(v
 }
 
 /**
- * \brief Timeout handler. Aborts test run and exits harness process.
+ * Timeout handler. Aborts test run and exits harness process.
  */
 #ifdef __WATCOMC__
 #pragma aux SDLTest_BailOut aborts;
@@ -223,7 +223,7 @@ static SDL_NORETURN void SDLCALL SDLTest_BailOut(void)
 }
 
 /**
- * \brief Execute a test using the given execution key.
+ * Execute a test using the given execution key.
  *
  * \param testSuite Suite containing the test case.
  * \param testCase Case to execute.
@@ -356,7 +356,7 @@ static float GetClock(void)
 }
 
 /**
- * \brief Execute a test suite using the given run seed and execution key.
+ * Execute a test suite using the given run seed and execution key.
  *
  * The filter string is matched to the suite name (full comparison) to select a single suite,
  * or if no suite matches, it is matched to the test names (full comparison) to select a single test.

+ 18 - 18
test/testautomation_audio.c

@@ -59,7 +59,7 @@ static SDL_AudioDeviceID g_audio_id = -1;
 /* Test case functions */
 
 /**
- * \brief Stop and restart audio subsystem
+ * Stop and restart audio subsystem
  *
  * \sa SDL_QuitSubSystem
  * \sa SDL_InitSubSystem
@@ -77,7 +77,7 @@ static int audio_quitInitAudioSubSystem(void *arg)
 }
 
 /**
- * \brief Start and stop audio directly
+ * Start and stop audio directly
  *
  * \sa SDL_InitAudio
  * \sa SDL_QuitAudio
@@ -133,7 +133,7 @@ static int audio_initQuitAudio(void *arg)
 }
 
 /**
- * \brief Start, open, close and stop audio
+ * Start, open, close and stop audio
  *
  * \sa SDL_InitAudio
  * \sa SDL_OpenAudioDevice
@@ -219,7 +219,7 @@ static int audio_initOpenCloseQuitAudio(void *arg)
 }
 
 /**
- * \brief Pause and unpause audio
+ * Pause and unpause audio
  *
  * \sa SDL_PauseAudioDevice
  * \sa SDL_PlayAudioDevice
@@ -340,7 +340,7 @@ static int audio_pauseUnpauseAudio(void *arg)
 }
 
 /**
- * \brief Enumerate and name available audio devices (output and capture).
+ * Enumerate and name available audio devices (output and capture).
  *
  * \sa SDL_GetNumAudioDevices
  * \sa SDL_GetAudioDeviceName
@@ -381,7 +381,7 @@ static int audio_enumerateAndNameAudioDevices(void *arg)
 }
 
 /**
- * \brief Negative tests around enumeration and naming of audio devices.
+ * Negative tests around enumeration and naming of audio devices.
  *
  * \sa SDL_GetNumAudioDevices
  * \sa SDL_GetAudioDeviceName
@@ -392,7 +392,7 @@ static int audio_enumerateAndNameAudioDevicesNegativeTests(void *arg)
 }
 
 /**
- * \brief Checks available audio driver names.
+ * Checks available audio driver names.
  *
  * \sa SDL_GetNumAudioDrivers
  * \sa SDL_GetAudioDriver
@@ -423,7 +423,7 @@ static int audio_printAudioDrivers(void *arg)
 }
 
 /**
- * \brief Checks current audio driver name with initialized audio.
+ * Checks current audio driver name with initialized audio.
  *
  * \sa SDL_GetCurrentAudioDriver
  */
@@ -470,7 +470,7 @@ SDL_COMPILE_TIME_ASSERT(SDL_AUDIO_F32LE_FORMAT, SDL_AUDIO_F32LE == (SDL_AUDIO_BI
 SDL_COMPILE_TIME_ASSERT(SDL_AUDIO_F32BE_FORMAT, SDL_AUDIO_F32BE == (SDL_AUDIO_F32LE | SDL_AUDIO_MASK_BIG_ENDIAN));
 
 /**
- * \brief Builds various audio conversion structures
+ * Builds various audio conversion structures
  *
  * \sa SDL_CreateAudioStream
  */
@@ -539,7 +539,7 @@ static int audio_buildAudioStream(void *arg)
 }
 
 /**
- * \brief Checks calls with invalid input to SDL_CreateAudioStream
+ * Checks calls with invalid input to SDL_CreateAudioStream
  *
  * \sa SDL_CreateAudioStream
  */
@@ -619,7 +619,7 @@ static int audio_buildAudioStreamNegative(void *arg)
 }
 
 /**
- * \brief Checks current audio status.
+ * Checks current audio status.
  *
  * \sa SDL_GetAudioDeviceStatus
  */
@@ -629,7 +629,7 @@ static int audio_getAudioStatus(void *arg)
 }
 
 /**
- * \brief Opens, checks current audio status, and closes a device.
+ * Opens, checks current audio status, and closes a device.
  *
  * \sa SDL_GetAudioStatus
  */
@@ -639,7 +639,7 @@ static int audio_openCloseAndGetAudioStatus(void *arg)
 }
 
 /**
- * \brief Locks and unlocks open audio device.
+ * Locks and unlocks open audio device.
  *
  * \sa SDL_LockAudioDevice
  * \sa SDL_UnlockAudioDevice
@@ -650,7 +650,7 @@ static int audio_lockUnlockOpenAudioDevice(void *arg)
 }
 
 /**
- * \brief Convert audio using various conversion structures
+ * Convert audio using various conversion structures
  *
  * \sa SDL_CreateAudioStream
  */
@@ -784,7 +784,7 @@ static int audio_convertAudio(void *arg)
 }
 
 /**
- * \brief Opens, checks current connected status, and closes a device.
+ * Opens, checks current connected status, and closes a device.
  *
  * \sa SDL_AudioDeviceConnected
  */
@@ -806,7 +806,7 @@ static double sine_wave_sample(const Sint64 idx, const Sint64 rate, const Sint64
 }
 
 /**
- * \brief Check signal-to-noise ratio and maximum error of audio resampling.
+ * Check signal-to-noise ratio and maximum error of audio resampling.
  *
  * \sa https://wiki.libsdl.org/SDL_CreateAudioStream
  * \sa https://wiki.libsdl.org/SDL_DestroyAudioStream
@@ -963,7 +963,7 @@ static int audio_resampleLoss(void *arg)
 }
 
 /**
- * \brief Check accuracy converting between audio formats.
+ * Check accuracy converting between audio formats.
  *
  * \sa SDL_ConvertAudioSamples
  */
@@ -1098,7 +1098,7 @@ static int audio_convertAccuracy(void *arg)
 }
 
 /**
- * \brief Check accuracy when switching between formats
+ * Check accuracy when switching between formats
  *
  * \sa SDL_SetAudioStreamFormat
  */

+ 3 - 3
test/testautomation_clipboard.c

@@ -74,7 +74,7 @@ static void ClipboardCleanupCallback(void *userdata)
 /* Test case functions */
 
 /**
- * \brief End-to-end test of SDL_xyzClipboardData functions
+ * End-to-end test of SDL_xyzClipboardData functions
  * \sa SDL_HasClipboardData
  * \sa SDL_GetClipboardData
  * \sa SDL_SetClipboardData
@@ -373,7 +373,7 @@ static int clipboard_testClipboardDataFunctions(void *arg)
 }
 
 /**
- * \brief End-to-end test of SDL_xyzClipboardText functions
+ * End-to-end test of SDL_xyzClipboardText functions
  * \sa SDL_HasClipboardText
  * \sa SDL_GetClipboardText
  * \sa SDL_SetClipboardText
@@ -457,7 +457,7 @@ static int clipboard_testClipboardTextFunctions(void *arg)
 }
 
 /**
- * \brief End-to-end test of SDL_xyzPrimarySelectionText functions
+ * End-to-end test of SDL_xyzPrimarySelectionText functions
  * \sa SDL_HasPrimarySelectionText
  * \sa SDL_GetPrimarySelectionText
  * \sa SDL_SetPrimarySelectionText

+ 3 - 3
test/testautomation_events.c

@@ -38,7 +38,7 @@ static int SDLCALL events_sampleNullEventFilter(void *userdata, SDL_Event *event
 }
 
 /**
- * \brief Test pumping and peeking events.
+ * Test pumping and peeking events.
  *
  * \sa SDL_PumpEvents
  * \sa SDL_PollEvent
@@ -75,7 +75,7 @@ static int events_pushPumpAndPollUserevent(void *arg)
 }
 
 /**
- * \brief Adds and deletes an event watch function with NULL userdata
+ * Adds and deletes an event watch function with NULL userdata
  *
  * \sa SDL_AddEventWatch
  * \sa SDL_DelEventWatch
@@ -125,7 +125,7 @@ static int events_addDelEventWatch(void *arg)
 }
 
 /**
- * \brief Adds and deletes an event watch function with userdata
+ * Adds and deletes an event watch function with userdata
  *
  * \sa SDL_AddEventWatch
  * \sa SDL_DelEventWatch

+ 2 - 2
test/testautomation_guid.c

@@ -70,7 +70,7 @@ upper_lower_to_bytestring(Uint8 *out, Uint64 upper, Uint64 lower)
 /* Test case functions */
 
 /**
- * \brief Check String-to-GUID conversion
+ * Check String-to-GUID conversion
  *
  * \sa SDL_GUIDFromString
  */
@@ -95,7 +95,7 @@ TestGuidFromString(void *arg)
 }
 
 /**
- * \brief Check GUID-to-String conversion
+ * Check GUID-to-String conversion
  *
  * \sa SDL_GUIDToString
  */

+ 2 - 2
test/testautomation_hints.c

@@ -60,7 +60,7 @@ static const int numHintsEnum = SDL_arraysize(HintsEnum);
 /* Test case functions */
 
 /**
- * \brief Call to SDL_GetHint
+ * Call to SDL_GetHint
  */
 static int hints_getHint(void *arg)
 {
@@ -89,7 +89,7 @@ static void SDLCALL hints_testHintChanged(void *userdata, const char *name, cons
 }
 
 /**
- * \brief Call to SDL_SetHint
+ * Call to SDL_SetHint
  */
 static int hints_setHint(void *arg)
 {

+ 11 - 11
test/testautomation_images.c

@@ -528,7 +528,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlit = {
 };
 
 /**
- * \brief Returns the Blit test image as SDL_Surface.
+ * Returns the Blit test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageBlit(void)
 {
@@ -1000,7 +1000,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitColor = {
 };
 
 /**
- * \brief Returns the BlitColor test image as SDL_Surface.
+ * Returns the BlitColor test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageBlitColor(void)
 {
@@ -1635,7 +1635,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitAlpha = {
 };
 
 /**
- * \brief Returns the BlitAlpha test image as SDL_Surface.
+ * Returns the BlitAlpha test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageBlitAlpha(void)
 {
@@ -2203,7 +2203,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlendAdd = {
 };
 
 /**
- * \brief Returns the BlitBlendAdd test image as SDL_Surface.
+ * Returns the BlitBlendAdd test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageBlitBlendAdd(void)
 {
@@ -2792,7 +2792,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlend = {
 };
 
 /**
- * \brief Returns the BlitBlend test image as SDL_Surface.
+ * Returns the BlitBlend test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageBlitBlend(void)
 {
@@ -3211,7 +3211,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlendMod = {
 };
 
 /**
- * \brief Returns the BlitBlendMod test image as SDL_Surface.
+ * Returns the BlitBlendMod test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageBlitBlendMod(void)
 {
@@ -4013,7 +4013,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlendNone = {
 };
 
 /**
- * \brief Returns the BlitBlendNone test image as SDL_Surface.
+ * Returns the BlitBlendNone test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageBlitBlendNone(void)
 {
@@ -4547,7 +4547,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageBlitBlendAll = {
 };
 
 /**
- * \brief Returns the BlitBlendAll test image as SDL_Surface.
+ * Returns the BlitBlendAll test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageBlitBlendAll(void)
 {
@@ -4758,7 +4758,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imageFace = {
 };
 
 /**
- * \brief Returns the Face test image as SDL_Surface.
+ * Returns the Face test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImageFace(void)
 {
@@ -5251,7 +5251,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imagePrimitives = {
 };
 
 /**
- * \brief Returns the Primitives test image as SDL_Surface.
+ * Returns the Primitives test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImagePrimitives(void)
 {
@@ -5916,7 +5916,7 @@ static const SDLTest_SurfaceImage_t SDLTest_imagePrimitivesBlend = {
 };
 
 /**
- * \brief Returns the PrimitivesBlend test image as SDL_Surface.
+ * Returns the PrimitivesBlend test image as SDL_Surface.
  */
 SDL_Surface *SDLTest_ImagePrimitivesBlend(void)
 {

+ 4 - 4
test/testautomation_intrinsics.c

@@ -86,7 +86,7 @@ static void free_arrays(void *dest, void *a, void *b) {
 }
 
 /**
- * \brief Verify element-wise addition of 2 int arrays.
+ * Verify element-wise addition of 2 int arrays.
  */
 static void verify_ints_addition(const Sint32 *dest, const Sint32 *a, const Sint32 *b, size_t size, const char *desc) {
     size_t i;
@@ -106,7 +106,7 @@ static void verify_ints_addition(const Sint32 *dest, const Sint32 *a, const Sint
 }
 
 /**
- * \brief Verify element-wise multiplication of 2 int arrays.
+ * Verify element-wise multiplication of 2 int arrays.
  */
 static void verify_ints_multiplication(const Sint32 *dest, const Sint32 *a, const Sint32 *b, size_t size, const char *desc) {
     size_t i;
@@ -126,7 +126,7 @@ static void verify_ints_multiplication(const Sint32 *dest, const Sint32 *a, cons
 }
 
 /**
- * \brief Verify element-wise addition of 2 float arrays.
+ * Verify element-wise addition of 2 float arrays.
  */
 static void verify_floats_addition(const float *dest, const float *a, const float *b, size_t size, const char *desc) {
     size_t i;
@@ -147,7 +147,7 @@ static void verify_floats_addition(const float *dest, const float *a, const floa
 }
 
 /**
- * \brief Verify element-wise addition of 2 double arrays.
+ * Verify element-wise addition of 2 double arrays.
  */
 static void verify_doubles_addition(const double *dest, const double *a, const double *b, size_t size, const char *desc) {
     size_t i;

+ 1 - 1
test/testautomation_joystick.c

@@ -12,7 +12,7 @@
 /* Test case functions */
 
 /**
- * \brief Check virtual joystick creation
+ * Check virtual joystick creation
  *
  * \sa SDL_AttachVirtualJoystickEx
  */

+ 14 - 14
test/testautomation_keyboard.c

@@ -11,7 +11,7 @@
 /* Test case functions */
 
 /**
- * \brief Check call to SDL_GetKeyboardState with and without numkeys reference.
+ * Check call to SDL_GetKeyboardState with and without numkeys reference.
  *
  * \sa SDL_GetKeyboardState
  */
@@ -36,7 +36,7 @@ static int keyboard_getKeyboardState(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetKeyboardFocus
+ * Check call to SDL_GetKeyboardFocus
  *
  * \sa SDL_GetKeyboardFocus
  */
@@ -50,7 +50,7 @@ static int keyboard_getKeyboardFocus(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetKeyFromName for known, unknown and invalid name.
+ * Check call to SDL_GetKeyFromName for known, unknown and invalid name.
  *
  * \sa SDL_GetKeyFromName
  */
@@ -115,7 +115,7 @@ static void checkInvalidScancodeError(void)
 }
 
 /**
- * \brief Check call to SDL_GetKeyFromScancode
+ * Check call to SDL_GetKeyFromScancode
  *
  * \sa SDL_GetKeyFromScancode
  */
@@ -153,7 +153,7 @@ static int keyboard_getKeyFromScancode(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetKeyName
+ * Check call to SDL_GetKeyName
  *
  * \sa SDL_GetKeyName
  */
@@ -208,7 +208,7 @@ static int keyboard_getKeyName(void *arg)
 }
 
 /**
- * \brief SDL_GetScancodeName negative cases
+ * SDL_GetScancodeName negative cases
  *
  * \sa SDL_GetScancodeName
  */
@@ -234,7 +234,7 @@ static int keyboard_getScancodeNameNegative(void *arg)
 }
 
 /**
- * \brief SDL_GetKeyName negative cases
+ * SDL_GetKeyName negative cases
  *
  * \sa SDL_GetKeyName
  */
@@ -270,7 +270,7 @@ static int keyboard_getKeyNameNegative(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetModState and SDL_SetModState
+ * Check call to SDL_GetModState and SDL_SetModState
  *
  * \sa SDL_GetModState
  * \sa SDL_SetModState
@@ -329,7 +329,7 @@ static int keyboard_getSetModState(void *arg)
 }
 
 /**
- * \brief Check call to SDL_StartTextInput and SDL_StopTextInput
+ * Check call to SDL_StartTextInput and SDL_StopTextInput
  *
  * \sa SDL_StartTextInput
  * \sa SDL_StopTextInput
@@ -375,7 +375,7 @@ static void testSetTextInputRect(SDL_Rect refRect)
 }
 
 /**
- * \brief Check call to SDL_SetTextInputRect
+ * Check call to SDL_SetTextInputRect
  *
  * \sa SDL_SetTextInputRect
  */
@@ -454,7 +454,7 @@ static int keyboard_setTextInputRect(void *arg)
 }
 
 /**
- * \brief Check call to SDL_SetTextInputRect with invalid data
+ * Check call to SDL_SetTextInputRect with invalid data
  *
  * \sa SDL_SetTextInputRect
  */
@@ -491,7 +491,7 @@ static int keyboard_setTextInputRectNegative(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetScancodeFromKey
+ * Check call to SDL_GetScancodeFromKey
  *
  * \sa SDL_GetScancodeFromKey
  * \sa SDL_Keycode
@@ -514,7 +514,7 @@ static int keyboard_getScancodeFromKey(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetScancodeFromName
+ * Check call to SDL_GetScancodeFromName
  *
  * \sa SDL_GetScancodeFromName
  * \sa SDL_Keycode
@@ -585,7 +585,7 @@ static void checkInvalidNameError(void)
 }
 
 /**
- * \brief Check call to SDL_GetScancodeFromName with invalid data
+ * Check call to SDL_GetScancodeFromName with invalid data
  *
  * \sa SDL_GetScancodeFromName
  * \sa SDL_Keycode

+ 1 - 1
test/testautomation_main.c

@@ -11,7 +11,7 @@
 #include "testautomation_suites.h"
 
 /**
- * \brief Tests SDL_InitSubSystem() and SDL_QuitSubSystem()
+ * Tests SDL_InitSubSystem() and SDL_QuitSubSystem()
  * \sa SDL_Init
  * \sa SDL_Quit
  */

+ 5 - 5
test/testautomation_math.c

@@ -62,7 +62,7 @@ typedef double(SDLCALL *d_to_d_func)(double);
 typedef double(SDLCALL *dd_to_d_func)(double, double);
 
 /**
- * \brief Runs all the cases on a given function with a signature double -> double.
+ * Runs all the cases on a given function with a signature double -> double.
  * The result is expected to be exact.
  *
  * \param func_name a printable name for the tested function.
@@ -88,7 +88,7 @@ helper_dtod(const char *func_name, d_to_d_func func,
 }
 
 /**
- * \brief Runs all the cases on a given function with a signature double -> double.
+ * Runs all the cases on a given function with a signature double -> double.
  * Checks if the result between expected +/- EPSILON.
  *
  * \param func_name a printable name for the tested function.
@@ -117,7 +117,7 @@ helper_dtod_inexact(const char *func_name, d_to_d_func func,
 }
 
 /**
- * \brief Runs all the cases on a given function with a signature
+ * Runs all the cases on a given function with a signature
  * (double, double) -> double. The result is expected to be exact.
  *
  * \param func_name a printable name for the tested function.
@@ -143,7 +143,7 @@ helper_ddtod(const char *func_name, dd_to_d_func func,
 }
 
 /**
- * \brief Runs all the cases on a given function with a signature
+ * Runs all the cases on a given function with a signature
  * (double, double) -> double. Checks if the result between expected +/- EPSILON.
  *
  * \param func_name a printable name for the tested function.
@@ -172,7 +172,7 @@ helper_ddtod_inexact(const char *func_name, dd_to_d_func func,
 }
 
 /**
- * \brief Runs a range of values on a given function with a signature double -> double
+ * Runs a range of values on a given function with a signature double -> double
  *
  * This function is only meant to test functions that returns the input value if it is
  * integral: f(x) -> x for x in N.

+ 12 - 12
test/testautomation_mouse.c

@@ -25,7 +25,7 @@ static int mouseStateCheck(Uint32 state)
 }
 
 /**
- * \brief Check call to SDL_GetMouseState
+ * Check call to SDL_GetMouseState
  *
  */
 static int mouse_getMouseState(void *arg)
@@ -70,7 +70,7 @@ static int mouse_getMouseState(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetRelativeMouseState
+ * Check call to SDL_GetRelativeMouseState
  *
  */
 static int mouse_getRelativeMouseState(void *arg)
@@ -188,7 +188,7 @@ static SDL_Cursor *initArrowCursor(const char *image[])
 }
 
 /**
- * \brief Check call to SDL_CreateCursor and SDL_DestroyCursor
+ * Check call to SDL_CreateCursor and SDL_DestroyCursor
  *
  * \sa SDL_CreateCursor
  * \sa SDL_DestroyCursor
@@ -213,7 +213,7 @@ static int mouse_createFreeCursor(void *arg)
 }
 
 /**
- * \brief Check call to SDL_CreateColorCursor and SDL_DestroyCursor
+ * Check call to SDL_CreateColorCursor and SDL_DestroyCursor
  *
  * \sa SDL_CreateColorCursor
  * \sa SDL_DestroyCursor
@@ -269,7 +269,7 @@ static void changeCursorVisibility(SDL_bool state)
 }
 
 /**
- * \brief Check call to SDL_ShowCursor
+ * Check call to SDL_ShowCursor
  *
  * \sa SDL_ShowCursor
  */
@@ -294,7 +294,7 @@ static int mouse_showCursor(void *arg)
 }
 
 /**
- * \brief Check call to SDL_SetCursor
+ * Check call to SDL_SetCursor
  *
  * \sa SDL_SetCursor
  */
@@ -326,7 +326,7 @@ static int mouse_setCursor(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetCursor
+ * Check call to SDL_GetCursor
  *
  * \sa SDL_GetCursor
  */
@@ -343,7 +343,7 @@ static int mouse_getCursor(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetRelativeMouseMode and SDL_SetRelativeMouseMode
+ * Check call to SDL_GetRelativeMouseMode and SDL_SetRelativeMouseMode
  *
  * \sa SDL_GetRelativeMouseMode
  * \sa SDL_SetRelativeMouseMode
@@ -426,7 +426,7 @@ static void destroyMouseSuiteTestWindow(SDL_Window *window)
 }
 
 /**
- * \brief Check call to SDL_WarpMouseInWindow
+ * Check call to SDL_WarpMouseInWindow
  *
  * \sa SDL_WarpMouseInWindow
  */
@@ -489,7 +489,7 @@ static int mouse_warpMouseInWindow(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetMouseFocus
+ * Check call to SDL_GetMouseFocus
  *
  * \sa SDL_GetMouseFocus
  */
@@ -555,7 +555,7 @@ static int mouse_getMouseFocus(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetDefaultCursor
+ * Check call to SDL_GetDefaultCursor
  *
  * \sa SDL_GetDefaultCursor
  */
@@ -572,7 +572,7 @@ static int mouse_getDefaultCursor(void *arg)
 }
 
 /**
- * \brief Check call to SDL_GetGlobalMouseState
+ * Check call to SDL_GetGlobalMouseState
  *
  * \sa SDL_GetGlobalMouseState
  */

+ 3 - 3
test/testautomation_pixels.c

@@ -111,7 +111,7 @@ static const char *g_invalidPixelFormatsVerbose[] = {
 /* Test case functions */
 
 /**
- * \brief Call to SDL_CreatePixelFormat and SDL_DestroyPixelFormat
+ * Call to SDL_CreatePixelFormat and SDL_DestroyPixelFormat
  *
  * \sa SDL_CreatePixelFormat
  * \sa SDL_DestroyPixelFormat
@@ -204,7 +204,7 @@ static int pixels_allocFreeFormat(void *arg)
 }
 
 /**
- * \brief Call to SDL_GetPixelFormatName
+ * Call to SDL_GetPixelFormatName
  *
  * \sa SDL_GetPixelFormatName
  */
@@ -271,7 +271,7 @@ static int pixels_getPixelFormatName(void *arg)
 }
 
 /**
- * \brief Call to SDL_CreatePalette and SDL_DestroyPalette
+ * Call to SDL_CreatePalette and SDL_DestroyPalette
  *
  * \sa SDL_CreatePalette
  * \sa SDL_DestroyPalette

+ 12 - 12
test/testautomation_platform.c

@@ -11,7 +11,7 @@
 /* Helper functions */
 
 /**
- * \brief Compare sizes of types.
+ * Compare sizes of types.
  *
  * @note Watcom C flags these as Warning 201: "Unreachable code" if you just
  *  compare them directly, so we push it through a function to keep the
@@ -25,7 +25,7 @@ static int compareSizeOfType(size_t sizeoftype, size_t hardcodetype)
 /* Test case functions */
 
 /**
- * \brief Tests type sizes.
+ * Tests type sizes.
  */
 static int platform_testTypes(void *arg)
 {
@@ -47,7 +47,7 @@ static int platform_testTypes(void *arg)
 }
 
 /**
- * \brief Tests platform endianness and SDL_SwapXY functions.
+ * Tests platform endianness and SDL_SwapXY functions.
  */
 static int platform_testEndianessAndSwap(void *arg)
 {
@@ -118,7 +118,7 @@ static int platform_testEndianessAndSwap(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetXYZ() functions
+ * Tests SDL_GetXYZ() functions
  * \sa SDL_GetPlatform
  * \sa SDL_GetCPUCount
  * \sa SDL_GetRevision
@@ -162,7 +162,7 @@ static int platform_testGetFunctions(void *arg)
 }
 
 /**
- * \brief Tests SDL_HasXYZ() functions
+ * Tests SDL_HasXYZ() functions
  * \sa SDL_HasAltiVec
  * \sa SDL_HasMMX
  * \sa SDL_HasSSE
@@ -204,7 +204,7 @@ static int platform_testHasFunctions(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetVersion
+ * Tests SDL_GetVersion
  * \sa SDL_GetVersion
  */
 static int platform_testGetVersion(void *arg)
@@ -227,7 +227,7 @@ static int platform_testGetVersion(void *arg)
 }
 
 /**
- * \brief Tests SDL_VERSION macro
+ * Tests SDL_VERSION macro
  */
 static int platform_testSDLVersion(void *arg)
 {
@@ -249,7 +249,7 @@ static int platform_testSDLVersion(void *arg)
 }
 
 /**
- * \brief Tests default SDL_Init
+ * Tests default SDL_Init
  */
 static int platform_testDefaultInit(void *arg)
 {
@@ -271,7 +271,7 @@ static int platform_testDefaultInit(void *arg)
 }
 
 /**
- * \brief Tests SDL_Get/Set/ClearError
+ * Tests SDL_Get/Set/ClearError
  * \sa SDL_GetError
  * \sa SDL_SetError
  * \sa SDL_ClearError
@@ -322,7 +322,7 @@ static int platform_testGetSetClearError(void *arg)
 }
 
 /**
- * \brief Tests SDL_SetError with empty input
+ * Tests SDL_SetError with empty input
  * \sa SDL_SetError
  */
 static int platform_testSetErrorEmptyInput(void *arg)
@@ -363,7 +363,7 @@ static int platform_testSetErrorEmptyInput(void *arg)
 #endif
 
 /**
- * \brief Tests SDL_SetError with invalid input
+ * Tests SDL_SetError with invalid input
  * \sa SDL_SetError
  */
 static int platform_testSetErrorInvalidInput(void *arg)
@@ -446,7 +446,7 @@ static int platform_testSetErrorInvalidInput(void *arg)
 #endif
 
 /**
- * \brief Tests SDL_GetPowerInfo
+ * Tests SDL_GetPowerInfo
  * \sa SDL_GetPowerInfo
  */
 static int platform_testGetPowerInfo(void *arg)

+ 3 - 3
test/testautomation_properties.c

@@ -9,7 +9,7 @@
 /* Test case functions */
 
 /**
- * \brief Test basic functionality
+ * Test basic functionality
  */
 static int properties_testBasic(void *arg)
 {
@@ -54,7 +54,7 @@ static int properties_testBasic(void *arg)
 }
 
 /**
- * \brief Test cleanup functionality
+ * Test cleanup functionality
  */
 static void SDLCALL cleanup(void *userdata, void *value)
 {
@@ -91,7 +91,7 @@ static int properties_testCleanup(void *arg)
 }
 
 /**
- * \brief Test locking functionality
+ * Test locking functionality
  */
 struct properties_thread_data
 {

+ 39 - 39
test/testautomation_rect.c

@@ -11,7 +11,7 @@
 /* Helper functions */
 
 /**
- * \brief Private helper to check SDL_GetRectAndLineIntersection results
+ * Private helper to check SDL_GetRectAndLineIntersection results
  */
 static void validateIntersectRectAndLineResults(
     SDL_bool intersection, SDL_bool expectedIntersection,
@@ -38,7 +38,7 @@ static void validateIntersectRectAndLineResults(
 /* Test case functions */
 
 /**
- * \brief Tests SDL_GetRectAndLineIntersection() clipping cases
+ * Tests SDL_GetRectAndLineIntersection() clipping cases
  *
  * \sa SDL_GetRectAndLineIntersection
  */
@@ -107,7 +107,7 @@ static int rect_testIntersectRectAndLine(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectAndLineIntersection() non-clipping case line inside
+ * Tests SDL_GetRectAndLineIntersection() non-clipping case line inside
  *
  * \sa SDL_GetRectAndLineIntersection
  */
@@ -172,7 +172,7 @@ static int rect_testIntersectRectAndLineInside(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectAndLineIntersection() non-clipping cases outside
+ * Tests SDL_GetRectAndLineIntersection() non-clipping cases outside
  *
  * \sa SDL_GetRectAndLineIntersection
  */
@@ -225,7 +225,7 @@ static int rect_testIntersectRectAndLineOutside(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectAndLineIntersection() with empty rectangle
+ * Tests SDL_GetRectAndLineIntersection() with empty rectangle
  *
  * \sa SDL_GetRectAndLineIntersection
  */
@@ -258,7 +258,7 @@ static int rect_testIntersectRectAndLineEmpty(void *arg)
 }
 
 /**
- * \brief Negative tests against SDL_GetRectAndLineIntersection() with invalid parameters
+ * Negative tests against SDL_GetRectAndLineIntersection() with invalid parameters
  *
  * \sa SDL_GetRectAndLineIntersection
  */
@@ -291,7 +291,7 @@ static int rect_testIntersectRectAndLineParam(void *arg)
 }
 
 /**
- * \brief Private helper to check SDL_HasRectIntersection results
+ * Private helper to check SDL_HasRectIntersection results
  */
 static void validateHasIntersectionResults(
     SDL_bool intersection, SDL_bool expectedIntersection,
@@ -314,7 +314,7 @@ static void validateHasIntersectionResults(
 }
 
 /**
- * \brief Private helper to check SDL_GetRectIntersection results
+ * Private helper to check SDL_GetRectIntersection results
  */
 static void validateIntersectRectResults(
     SDL_bool intersection, SDL_bool expectedIntersection,
@@ -333,7 +333,7 @@ static void validateIntersectRectResults(
 }
 
 /**
- * \brief Private helper to check SDL_GetRectUnion results
+ * Private helper to check SDL_GetRectUnion results
  */
 static void validateUnionRectResults(
     SDL_Rect *rectA, SDL_Rect *rectB, SDL_Rect *refRectA, SDL_Rect *refRectB,
@@ -356,7 +356,7 @@ static void validateUnionRectResults(
 }
 
 /**
- * \brief Private helper to check SDL_RectEmpty results
+ * Private helper to check SDL_RectEmpty results
  */
 static void validateRectEmptyResults(
     SDL_bool empty, SDL_bool expectedEmpty,
@@ -374,7 +374,7 @@ static void validateRectEmptyResults(
 }
 
 /**
- * \brief Private helper to check SDL_RectsEqual results
+ * Private helper to check SDL_RectsEqual results
  */
 static void validateRectEqualsResults(
     SDL_bool equals, SDL_bool expectedEquals,
@@ -397,7 +397,7 @@ static void validateRectEqualsResults(
 }
 
 /**
- * \brief Private helper to check SDL_RectsEqualFloat results
+ * Private helper to check SDL_RectsEqualFloat results
  */
 static void validateFRectEqualsResults(
     SDL_bool equals, SDL_bool expectedEquals,
@@ -423,7 +423,7 @@ static void validateFRectEqualsResults(
 }
 
 /**
- * \brief Tests SDL_GetRectIntersection() with B fully inside A
+ * Tests SDL_GetRectIntersection() with B fully inside A
  *
  * \sa SDL_GetRectIntersection
  */
@@ -450,7 +450,7 @@ static int rect_testIntersectRectInside(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectIntersection() with B fully outside A
+ * Tests SDL_GetRectIntersection() with B fully outside A
  *
  * \sa SDL_GetRectIntersection
  */
@@ -477,7 +477,7 @@ static int rect_testIntersectRectOutside(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectIntersection() with B partially intersecting A
+ * Tests SDL_GetRectIntersection() with B partially intersecting A
  *
  * \sa SDL_GetRectIntersection
  */
@@ -565,7 +565,7 @@ static int rect_testIntersectRectPartial(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectIntersection() with 1x1 pixel sized rectangles
+ * Tests SDL_GetRectIntersection() with 1x1 pixel sized rectangles
  *
  * \sa SDL_GetRectIntersection
  */
@@ -611,7 +611,7 @@ static int rect_testIntersectRectPoint(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectIntersection() with empty rectangles
+ * Tests SDL_GetRectIntersection() with empty rectangles
  *
  * \sa SDL_GetRectIntersection
  */
@@ -682,7 +682,7 @@ static int rect_testIntersectRectEmpty(void *arg)
 }
 
 /**
- * \brief Negative tests against SDL_GetRectIntersection() with invalid parameters
+ * Negative tests against SDL_GetRectIntersection() with invalid parameters
  *
  * \sa SDL_GetRectIntersection
  */
@@ -711,7 +711,7 @@ static int rect_testIntersectRectParam(void *arg)
 }
 
 /**
- * \brief Tests SDL_HasRectIntersection() with B fully inside A
+ * Tests SDL_HasRectIntersection() with B fully inside A
  *
  * \sa SDL_HasRectIntersection
  */
@@ -737,7 +737,7 @@ static int rect_testHasIntersectionInside(void *arg)
 }
 
 /**
- * \brief Tests SDL_HasRectIntersection() with B fully outside A
+ * Tests SDL_HasRectIntersection() with B fully outside A
  *
  * \sa SDL_HasRectIntersection
  */
@@ -763,7 +763,7 @@ static int rect_testHasIntersectionOutside(void *arg)
 }
 
 /**
- * \brief Tests SDL_HasRectIntersection() with B partially intersecting A
+ * Tests SDL_HasRectIntersection() with B partially intersecting A
  *
  * \sa SDL_HasRectIntersection
  */
@@ -829,7 +829,7 @@ static int rect_testHasIntersectionPartial(void *arg)
 }
 
 /**
- * \brief Tests SDL_HasRectIntersection() with 1x1 pixel sized rectangles
+ * Tests SDL_HasRectIntersection() with 1x1 pixel sized rectangles
  *
  * \sa SDL_HasRectIntersection
  */
@@ -874,7 +874,7 @@ static int rect_testHasIntersectionPoint(void *arg)
 }
 
 /**
- * \brief Tests SDL_HasRectIntersection() with empty rectangles
+ * Tests SDL_HasRectIntersection() with empty rectangles
  *
  * \sa SDL_HasRectIntersection
  */
@@ -931,7 +931,7 @@ static int rect_testHasIntersectionEmpty(void *arg)
 }
 
 /**
- * \brief Negative tests against SDL_HasRectIntersection() with invalid parameters
+ * Negative tests against SDL_HasRectIntersection() with invalid parameters
  *
  * \sa SDL_HasRectIntersection
  */
@@ -953,7 +953,7 @@ static int rect_testHasIntersectionParam(void *arg)
 }
 
 /**
- * \brief Test SDL_GetRectEnclosingPoints() without clipping
+ * Test SDL_GetRectEnclosingPoints() without clipping
  *
  * \sa SDL_GetRectEnclosingPoints
  */
@@ -1030,7 +1030,7 @@ static int rect_testEnclosePoints(void *arg)
 }
 
 /**
- * \brief Test SDL_GetRectEnclosingPoints() with repeated input points
+ * Test SDL_GetRectEnclosingPoints() with repeated input points
  *
  * \sa SDL_GetRectEnclosingPoints
  */
@@ -1113,7 +1113,7 @@ static int rect_testEnclosePointsRepeatedInput(void *arg)
 }
 
 /**
- * \brief Test SDL_GetRectEnclosingPoints() with clipping
+ * Test SDL_GetRectEnclosingPoints() with clipping
  *
  * \sa SDL_GetRectEnclosingPoints
  */
@@ -1219,7 +1219,7 @@ static int rect_testEnclosePointsWithClipping(void *arg)
 }
 
 /**
- * \brief Negative tests against SDL_GetRectEnclosingPoints() with invalid parameters
+ * Negative tests against SDL_GetRectEnclosingPoints() with invalid parameters
  *
  * \sa SDL_GetRectEnclosingPoints
  */
@@ -1246,7 +1246,7 @@ static int rect_testEnclosePointsParam(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectUnion() where rect B is outside rect A
+ * Tests SDL_GetRectUnion() where rect B is outside rect A
  *
  * \sa SDL_GetRectUnion
  */
@@ -1324,7 +1324,7 @@ static int rect_testUnionRectOutside(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectUnion() where rect A or rect B are empty
+ * Tests SDL_GetRectUnion() where rect A or rect B are empty
  *
  * \sa SDL_GetRectUnion
  */
@@ -1388,7 +1388,7 @@ static int rect_testUnionRectEmpty(void *arg)
 }
 
 /**
- * \brief Tests SDL_GetRectUnion() where rect B is inside rect A
+ * Tests SDL_GetRectUnion() where rect B is inside rect A
  *
  * \sa SDL_GetRectUnion
  */
@@ -1459,7 +1459,7 @@ static int rect_testUnionRectInside(void *arg)
 }
 
 /**
- * \brief Negative tests against SDL_GetRectUnion() with invalid parameters
+ * Negative tests against SDL_GetRectUnion() with invalid parameters
  *
  * \sa SDL_GetRectUnion
  */
@@ -1486,7 +1486,7 @@ static int rect_testUnionRectParam(void *arg)
 }
 
 /**
- * \brief Tests SDL_RectEmpty() with various inputs
+ * Tests SDL_RectEmpty() with various inputs
  *
  * \sa SDL_RectEmpty
  */
@@ -1528,7 +1528,7 @@ static int rect_testRectEmpty(void *arg)
 }
 
 /**
- * \brief Negative tests against SDL_RectEmpty() with invalid parameters
+ * Negative tests against SDL_RectEmpty() with invalid parameters
  *
  * \sa SDL_RectEmpty
  */
@@ -1544,7 +1544,7 @@ static int rect_testRectEmptyParam(void *arg)
 }
 
 /**
- * \brief Tests SDL_RectsEqual() with various inputs
+ * Tests SDL_RectsEqual() with various inputs
  *
  * \sa SDL_RectsEqual
  */
@@ -1573,7 +1573,7 @@ static int rect_testRectEquals(void *arg)
 }
 
 /**
- * \brief Negative tests against SDL_RectsEqual() with invalid parameters
+ * Negative tests against SDL_RectsEqual() with invalid parameters
  *
  * \sa SDL_RectsEqual
  */
@@ -1605,7 +1605,7 @@ static int rect_testRectEqualsParam(void *arg)
 }
 
 /**
- * \brief Tests SDL_RectsEqualFloat() with various inputs
+ * Tests SDL_RectsEqualFloat() with various inputs
  *
  * \sa SDL_RectsEqualFloat
  */
@@ -1634,7 +1634,7 @@ static int rect_testFRectEquals(void *arg)
 }
 
 /**
- * \brief Negative tests against SDL_RectsEqualFloat() with invalid parameters
+ * Negative tests against SDL_RectsEqualFloat() with invalid parameters
  *
  * \sa SDL_RectsEqualFloat
  */
@@ -1804,7 +1804,7 @@ static const SDLTest_TestCaseReference rectTest31 = {
 };
 
 /**
- * \brief Sequence of Rect test cases; functions that handle simple rectangles including overlaps and merges.
+ * Sequence of Rect test cases; functions that handle simple rectangles including overlaps and merges.
  */
 static const SDLTest_TestCaseReference *rectTests[] = {
     &rectTest1, &rectTest2, &rectTest3, &rectTest4, &rectTest5, &rectTest6, &rectTest7, &rectTest8, &rectTest9, &rectTest10, &rectTest11, &rectTest12, &rectTest13, &rectTest14,

+ 18 - 18
test/testautomation_render.c

@@ -90,7 +90,7 @@ static void CleanupDestroyRenderer(void *arg)
 }
 
 /**
- * \brief Tests call to SDL_GetNumRenderDrivers
+ * Tests call to SDL_GetNumRenderDrivers
  *
  * \sa SDL_GetNumRenderDrivers
  */
@@ -103,7 +103,7 @@ static int render_testGetNumRenderDrivers(void *arg)
 }
 
 /**
- * \brief Tests the SDL primitives for rendering.
+ * Tests the SDL primitives for rendering.
  *
  * \sa SDL_SetRenderDrawColor
  * \sa SDL_RenderFillRect
@@ -190,7 +190,7 @@ static int render_testPrimitives(void *arg)
 }
 
 /**
- * \brief Tests the SDL primitives with alpha for rendering.
+ * Tests the SDL primitives with alpha for rendering.
  *
  * \sa SDL_SetRenderDrawColor
  * \sa SDL_SetRenderDrawBlendMode
@@ -333,7 +333,7 @@ static int render_testPrimitivesBlend(void *arg)
 }
 
 /**
- * \brief Tests some blitting routines.
+ * Tests some blitting routines.
  *
  * \sa SDL_RenderTexture
  * \sa SDL_DestroyTexture
@@ -400,7 +400,7 @@ static int render_testBlit(void *arg)
 }
 
 /**
- * \brief Blits doing color tests.
+ * Blits doing color tests.
  *
  * \sa SDL_SetTextureColorMod
  * \sa SDL_RenderTexture
@@ -474,7 +474,7 @@ static int render_testBlitColor(void *arg)
 }
 
 /**
- * \brief Tests blitting with alpha.
+ * Tests blitting with alpha.
  *
  * \sa SDL_SetTextureAlphaMod
  * \sa SDL_RenderTexture
@@ -551,7 +551,7 @@ static int render_testBlitAlpha(void *arg)
 }
 
 /**
- * \brief Tests a blend mode.
+ * Tests a blend mode.
  *
  * \sa SDL_SetTextureBlendMode
  * \sa SDL_RenderTexture
@@ -602,7 +602,7 @@ testBlitBlendMode(SDL_Texture *tface, int mode)
 }
 
 /**
- * \brief Tests some more blitting routines.
+ * Tests some more blitting routines.
  *
  * \sa SDL_SetTextureColorMod
  * \sa SDL_SetTextureAlphaMod
@@ -759,7 +759,7 @@ static int render_testBlitBlend(void *arg)
 }
 
 /**
- * \brief Test viewport
+ * Test viewport
  */
 static int render_testViewport(void *arg)
 {
@@ -816,7 +816,7 @@ static int render_testViewport(void *arg)
 }
 
 /**
- * \brief Test logical size
+ * Test logical size
  */
 static int render_testLogicalSize(void *arg)
 {
@@ -926,7 +926,7 @@ static int render_testLogicalSize(void *arg)
 /* Helper functions */
 
 /**
- * \brief Checks to see if functionality is supported. Helper function.
+ * Checks to see if functionality is supported. Helper function.
  */
 static int
 isSupported(int code)
@@ -935,7 +935,7 @@ isSupported(int code)
 }
 
 /**
- * \brief Test to see if we can vary the draw color. Helper function.
+ * Test to see if we can vary the draw color. Helper function.
  *
  * \sa SDL_SetRenderDrawColor
  * \sa SDL_GetRenderDrawColor
@@ -976,7 +976,7 @@ hasDrawColor(void)
 }
 
 /**
- * \brief Test to see if we can vary the blend mode. Helper function.
+ * Test to see if we can vary the blend mode. Helper function.
  *
  * \sa SDL_SetRenderDrawBlendMode
  * \sa SDL_GetRenderDrawBlendMode
@@ -1043,7 +1043,7 @@ hasBlendModes(void)
 }
 
 /**
- * \brief Loads the test image 'Face' as texture. Helper function.
+ * Loads the test image 'Face' as texture. Helper function.
  *
  * \sa SDL_CreateTextureFromSurface
  */
@@ -1069,7 +1069,7 @@ loadTestFace(void)
 }
 
 /**
- * \brief Test to see if can set texture color mode. Helper function.
+ * Test to see if can set texture color mode. Helper function.
  *
  * \sa SDL_SetTextureColorMod
  * \sa SDL_GetTextureColorMod
@@ -1112,7 +1112,7 @@ hasTexColor(void)
 }
 
 /**
- * \brief Test to see if we can vary the alpha of the texture. Helper function.
+ * Test to see if we can vary the alpha of the texture. Helper function.
  *
  * \sa SDL_SetTextureAlphaMod
  * \sa SDL_GetTextureAlphaMod
@@ -1155,7 +1155,7 @@ hasTexAlpha(void)
 }
 
 /**
- * \brief Compares screen pixels with image pixels. Helper function.
+ * Compares screen pixels with image pixels. Helper function.
  *
  * \param referenceSurface Image to compare against.
  * \param allowable_error allowed difference from the reference image
@@ -1200,7 +1200,7 @@ compare(SDL_Surface *referenceSurface, int allowable_error)
 }
 
 /**
- * \brief Clears the screen. Helper function.
+ * Clears the screen. Helper function.
  *
  * \sa SDL_SetRenderDrawColor
  * \sa SDL_RenderClear

+ 8 - 8
test/testautomation_rwops.c

@@ -90,7 +90,7 @@ static void RWopsTearDown(void *arg)
 }
 
 /**
- * \brief Makes sure parameters work properly. Local helper function.
+ * Makes sure parameters work properly. Local helper function.
  *
  * \sa SDL_RWseek
  * \sa SDL_RWread
@@ -245,7 +245,7 @@ static int rwops_testParamNegative(void *arg)
 }
 
 /**
- * \brief Tests opening from memory.
+ * Tests opening from memory.
  *
  * \sa SDL_RWFromMem
  * \sa SDL_RWClose
@@ -284,7 +284,7 @@ static int rwops_testMem(void *arg)
 }
 
 /**
- * \brief Tests opening from memory.
+ * Tests opening from memory.
  *
  * \sa SDL_RWFromConstMem
  * \sa SDL_RWClose
@@ -319,7 +319,7 @@ static int rwops_testConstMem(void *arg)
 }
 
 /**
- * \brief Tests reading from file.
+ * Tests reading from file.
  *
  * \sa SDL_RWFromFile
  * \sa SDL_RWClose
@@ -366,7 +366,7 @@ static int rwops_testFileRead(void *arg)
 }
 
 /**
- * \brief Tests writing from file.
+ * Tests writing from file.
  *
  * \sa SDL_RWFromFile
  * \sa SDL_RWClose
@@ -413,7 +413,7 @@ static int rwops_testFileWrite(void *arg)
 }
 
 /**
- * \brief Tests alloc and free RW context.
+ * Tests alloc and free RW context.
  *
  * \sa SDL_CreateRW
  * \sa SDL_DestroyRW
@@ -441,7 +441,7 @@ static int rwops_testAllocFree(void *arg)
 }
 
 /**
- * \brief Compare memory and file reads
+ * Compare memory and file reads
  *
  * \sa SDL_RWFromMem
  * \sa SDL_RWFromFile
@@ -504,7 +504,7 @@ static int rwops_testCompareRWFromMemWithRWFromFile(void *arg)
 }
 
 /**
- * \brief Tests writing and reading from file using endian aware functions.
+ * Tests writing and reading from file using endian aware functions.
  *
  * \sa SDL_RWFromFile
  * \sa SDL_RWClose

+ 15 - 15
test/testautomation_sdltest.c

@@ -12,7 +12,7 @@
 /* Test case functions */
 
 /**
- * \brief Calls to SDLTest_GenerateRunSeed()
+ * Calls to SDLTest_GenerateRunSeed()
  */
 static int sdltest_generateRunSeed(void *arg)
 {
@@ -42,7 +42,7 @@ static int sdltest_generateRunSeed(void *arg)
 }
 
 /**
- * \brief Calls to SDLTest_GetFuzzerInvocationCount()
+ * Calls to SDLTest_GetFuzzerInvocationCount()
  */
 static int sdltest_getFuzzerInvocationCount(void *arg)
 {
@@ -64,7 +64,7 @@ static int sdltest_getFuzzerInvocationCount(void *arg)
 }
 
 /**
- * \brief Calls to random number generators
+ * Calls to random number generators
  */
 static int sdltest_randomNumber(void *arg)
 {
@@ -131,7 +131,7 @@ static int sdltest_randomNumber(void *arg)
 }
 
 /**
- * \brief Calls to random boundary number generators for Uint8
+ * Calls to random boundary number generators for Uint8
  */
 static int sdltest_randomBoundaryNumberUint8(void *arg)
 {
@@ -240,7 +240,7 @@ static int sdltest_randomBoundaryNumberUint8(void *arg)
 }
 
 /**
- * \brief Calls to random boundary number generators for Uint16
+ * Calls to random boundary number generators for Uint16
  */
 static int sdltest_randomBoundaryNumberUint16(void *arg)
 {
@@ -349,7 +349,7 @@ static int sdltest_randomBoundaryNumberUint16(void *arg)
 }
 
 /**
- * \brief Calls to random boundary number generators for Uint32
+ * Calls to random boundary number generators for Uint32
  */
 static int sdltest_randomBoundaryNumberUint32(void *arg)
 {
@@ -458,7 +458,7 @@ static int sdltest_randomBoundaryNumberUint32(void *arg)
 }
 
 /**
- * \brief Calls to random boundary number generators for Uint64
+ * Calls to random boundary number generators for Uint64
  */
 static int sdltest_randomBoundaryNumberUint64(void *arg)
 {
@@ -567,7 +567,7 @@ static int sdltest_randomBoundaryNumberUint64(void *arg)
 }
 
 /**
- * \brief Calls to random boundary number generators for Sint8
+ * Calls to random boundary number generators for Sint8
  */
 static int sdltest_randomBoundaryNumberSint8(void *arg)
 {
@@ -676,7 +676,7 @@ static int sdltest_randomBoundaryNumberSint8(void *arg)
 }
 
 /**
- * \brief Calls to random boundary number generators for Sint16
+ * Calls to random boundary number generators for Sint16
  */
 static int sdltest_randomBoundaryNumberSint16(void *arg)
 {
@@ -785,7 +785,7 @@ static int sdltest_randomBoundaryNumberSint16(void *arg)
 }
 
 /**
- * \brief Calls to random boundary number generators for Sint32
+ * Calls to random boundary number generators for Sint32
  */
 static int sdltest_randomBoundaryNumberSint32(void *arg)
 {
@@ -901,7 +901,7 @@ static int sdltest_randomBoundaryNumberSint32(void *arg)
 }
 
 /**
- * \brief Calls to random boundary number generators for Sint64
+ * Calls to random boundary number generators for Sint64
  */
 static int sdltest_randomBoundaryNumberSint64(void *arg)
 {
@@ -1010,7 +1010,7 @@ static int sdltest_randomBoundaryNumberSint64(void *arg)
 }
 
 /**
- * \brief Calls to SDLTest_RandomIntegerInRange
+ * Calls to SDLTest_RandomIntegerInRange
  */
 static int sdltest_randomIntegerInRange(void *arg)
 {
@@ -1084,7 +1084,7 @@ static int sdltest_randomIntegerInRange(void *arg)
 }
 
 /**
- * \brief Calls to SDLTest_RandomAsciiString
+ * Calls to SDLTest_RandomAsciiString
  */
 static int sdltest_randomAsciiString(void *arg)
 {
@@ -1116,7 +1116,7 @@ static int sdltest_randomAsciiString(void *arg)
 }
 
 /**
- * \brief Calls to SDLTest_RandomAsciiStringWithMaximumLength
+ * Calls to SDLTest_RandomAsciiStringWithMaximumLength
  */
 static int sdltest_randomAsciiStringWithMaximumLength(void *arg)
 {
@@ -1168,7 +1168,7 @@ static int sdltest_randomAsciiStringWithMaximumLength(void *arg)
 }
 
 /**
- * \brief Calls to SDLTest_RandomAsciiStringOfSize
+ * Calls to SDLTest_RandomAsciiStringOfSize
  */
 static int sdltest_randomAsciiStringOfSize(void *arg)
 {

+ 7 - 7
test/testautomation_stdlib.c

@@ -8,7 +8,7 @@
 /* Test case functions */
 
 /**
- * \brief Call to SDL_strnlen
+ * Call to SDL_strnlen
  */
 #undef SDL_strnlen
 static int stdlib_strnlen(void *arg)
@@ -36,7 +36,7 @@ static int stdlib_strnlen(void *arg)
 }
 
 /**
- * \brief Call to SDL_strlcpy
+ * Call to SDL_strlcpy
  */
 #undef SDL_strlcpy
 static int stdlib_strlcpy(void *arg)
@@ -71,7 +71,7 @@ static int stdlib_strlcpy(void *arg)
 #endif
 
 /**
- * \brief Call to SDL_snprintf
+ * Call to SDL_snprintf
  */
 #undef SDL_snprintf
 static int stdlib_snprintf(void *arg)
@@ -262,7 +262,7 @@ static int stdlib_snprintf(void *arg)
 }
 
 /**
- * \brief Call to SDL_swprintf
+ * Call to SDL_swprintf
  */
 #undef SDL_swprintf
 static int stdlib_swprintf(void *arg)
@@ -429,7 +429,7 @@ static int stdlib_swprintf(void *arg)
 #endif
 
 /**
- * \brief Call to SDL_getenv and SDL_setenv
+ * Call to SDL_getenv and SDL_setenv
  */
 static int stdlib_getsetenv(void *arg)
 {
@@ -572,7 +572,7 @@ static int stdlib_getsetenv(void *arg)
 #endif
 
 /**
- * \brief Call to SDL_sscanf
+ * Call to SDL_sscanf
  */
 #undef SDL_sscanf
 static int stdlib_sscanf(void *arg)
@@ -741,7 +741,7 @@ static int stdlib_sscanf(void *arg)
 #endif
 
 /**
- * \brief Call to SDL_aligned_alloc
+ * Call to SDL_aligned_alloc
  */
 static int stdlib_aligned_alloc(void *arg)
 {

+ 4 - 4
test/testautomation_subsystems.c

@@ -34,7 +34,7 @@ static void subsystemsTearDown(void *arg)
 /* Test case functions */
 
 /**
- * \brief Inits and Quits particular subsystem, checking its Init status.
+ * Inits and Quits particular subsystem, checking its Init status.
  *
  * \sa SDL_InitSubSystem
  * \sa SDL_QuitSubSystem
@@ -83,7 +83,7 @@ static int subsystems_referenceCount()
 }
 
 /**
- * \brief Inits and Quits subsystems that have another as dependency;
+ * Inits and Quits subsystems that have another as dependency;
  *        check that the dependency is not removed before the last of its dependents.
  *
  * \sa SDL_InitSubSystem
@@ -121,7 +121,7 @@ static int subsystems_dependRefCountInitAllQuitByOne()
 }
 
 /**
- * \brief Inits and Quits subsystems that have another as dependency;
+ * Inits and Quits subsystems that have another as dependency;
  *        check that the dependency is not removed before the last of its dependents.
  *
  * \sa SDL_InitSubSystem
@@ -155,7 +155,7 @@ static int subsystems_dependRefCountInitByOneQuitAll()
 }
 
 /**
- * \brief Inits and Quits subsystems that have another as dependency,
+ * Inits and Quits subsystems that have another as dependency,
  *        but also inits that dependency explicitly, giving it extra ref count.
  *        Check that the dependency is not removed before the last reference is gone.
  *

+ 10 - 10
test/testautomation_surface.c

@@ -209,7 +209,7 @@ static void AssertFileExist(const char *filename)
 /* Test case functions */
 
 /**
- * \brief Tests sprite saving and loading
+ * Tests sprite saving and loading
  */
 static int surface_testSaveLoadBitmap(void *arg)
 {
@@ -389,7 +389,7 @@ static int surface_testCompleteSurfaceConversion(void *arg)
 }
 
 /**
- * \brief Tests sprite loading. A failure case.
+ * Tests sprite loading. A failure case.
  */
 static int surface_testLoadFailure(void *arg)
 {
@@ -400,7 +400,7 @@ static int surface_testLoadFailure(void *arg)
 }
 
 /**
- * \brief Tests some blitting routines.
+ * Tests some blitting routines.
  */
 static int surface_testBlit(void *arg)
 {
@@ -422,7 +422,7 @@ static int surface_testBlit(void *arg)
 }
 
 /**
- * \brief Tests some blitting routines with color mod
+ * Tests some blitting routines with color mod
  */
 static int surface_testBlitColorMod(void *arg)
 {
@@ -444,7 +444,7 @@ static int surface_testBlitColorMod(void *arg)
 }
 
 /**
- * \brief Tests some blitting routines with alpha mod
+ * Tests some blitting routines with alpha mod
  */
 static int surface_testBlitAlphaMod(void *arg)
 {
@@ -466,7 +466,7 @@ static int surface_testBlitAlphaMod(void *arg)
 }
 
 /**
- * \brief Tests some more blitting routines.
+ * Tests some more blitting routines.
  */
 static int surface_testBlitBlendNone(void *arg)
 {
@@ -488,7 +488,7 @@ static int surface_testBlitBlendNone(void *arg)
 }
 
 /**
- * \brief Tests some more blitting routines.
+ * Tests some more blitting routines.
  */
 static int surface_testBlitBlendBlend(void *arg)
 {
@@ -510,7 +510,7 @@ static int surface_testBlitBlendBlend(void *arg)
 }
 
 /**
- * \brief Tests some more blitting routines.
+ * Tests some more blitting routines.
  */
 static int surface_testBlitBlendAdd(void *arg)
 {
@@ -532,7 +532,7 @@ static int surface_testBlitBlendAdd(void *arg)
 }
 
 /**
- * \brief Tests some more blitting routines.
+ * Tests some more blitting routines.
  */
 static int surface_testBlitBlendMod(void *arg)
 {
@@ -554,7 +554,7 @@ static int surface_testBlitBlendMod(void *arg)
 }
 
 /**
- * \brief Tests some more blitting routines with loop
+ * Tests some more blitting routines with loop
  */
 static int surface_testBlitBlendLoop(void *arg)
 {

+ 1 - 1
test/testautomation_syswm.c

@@ -13,7 +13,7 @@
 /* Test case functions */
 
 /**
- * \brief Call to SDL_GetWindowWMInfo
+ * Call to SDL_GetWindowWMInfo
  */
 static int syswm_getWindowWMInfo(void *arg)
 {

Některé soubory nejsou zobrazeny, neboť je v těchto rozdílových datech změněno mnoho souborů