Sync SDL3 header -> wiki

libsdl-org · Oct 16, 2024 · 6b25027 · 6b25027
1 parent c5ceefa
commit 6b25027
Show file tree

Hide file tree

Showing 2 changed files with 264 additions and 264 deletions.
diff --git a/SDL3/SDL_GamepadButton.md b/SDL3/SDL_GamepadButton.md
@@ -13,10 +13,10 @@ Defined in [<SDL3/SDL_gamepad.h>](https://github.com/libsdl-org/SDL/blob/main/in
 typedef enum SDL_GamepadButton
 {
  SDL_GAMEPAD_BUTTON_INVALID = -1,
- SDL_GAMEPAD_BUTTON_SOUTH, /* Bottom face button (e.g. Xbox A button) */
- SDL_GAMEPAD_BUTTON_EAST, /* Right face button (e.g. Xbox B button) */
- SDL_GAMEPAD_BUTTON_WEST, /* Left face button (e.g. Xbox X button) */
- SDL_GAMEPAD_BUTTON_NORTH, /* Top face button (e.g. Xbox Y button) */
+ SDL_GAMEPAD_BUTTON_SOUTH, /**< Bottom face button (e.g. Xbox A button) */
+ SDL_GAMEPAD_BUTTON_EAST, /**< Right face button (e.g. Xbox B button) */
+ SDL_GAMEPAD_BUTTON_WEST, /**< Left face button (e.g. Xbox X button) */
+ SDL_GAMEPAD_BUTTON_NORTH, /**< Top face button (e.g. Xbox Y button) */
  SDL_GAMEPAD_BUTTON_BACK,
  SDL_GAMEPAD_BUTTON_GUIDE,
  SDL_GAMEPAD_BUTTON_START,
@@ -28,17 +28,17 @@ typedef enum SDL_GamepadButton
  SDL_GAMEPAD_BUTTON_DPAD_DOWN,
  SDL_GAMEPAD_BUTTON_DPAD_LEFT,
  SDL_GAMEPAD_BUTTON_DPAD_RIGHT,
- SDL_GAMEPAD_BUTTON_MISC1, /* Additional button (e.g. Xbox Series X share button, PS5 microphone button, Nintendo Switch Pro capture button, Amazon Luna microphone button, Google Stadia capture button) */
- SDL_GAMEPAD_BUTTON_RIGHT_PADDLE1, /* Upper or primary paddle, under your right hand (e.g. Xbox Elite paddle P1) */
- SDL_GAMEPAD_BUTTON_LEFT_PADDLE1, /* Upper or primary paddle, under your left hand (e.g. Xbox Elite paddle P3) */
- SDL_GAMEPAD_BUTTON_RIGHT_PADDLE2, /* Lower or secondary paddle, under your right hand (e.g. Xbox Elite paddle P2) */
- SDL_GAMEPAD_BUTTON_LEFT_PADDLE2, /* Lower or secondary paddle, under your left hand (e.g. Xbox Elite paddle P4) */
- SDL_GAMEPAD_BUTTON_TOUCHPAD, /* PS4/PS5 touchpad button */
- SDL_GAMEPAD_BUTTON_MISC2, /* Additional button */
- SDL_GAMEPAD_BUTTON_MISC3, /* Additional button */
- SDL_GAMEPAD_BUTTON_MISC4, /* Additional button */
- SDL_GAMEPAD_BUTTON_MISC5, /* Additional button */
- SDL_GAMEPAD_BUTTON_MISC6, /* Additional button */
+ SDL_GAMEPAD_BUTTON_MISC1, /**< Additional button (e.g. Xbox Series X share button, PS5 microphone button, Nintendo Switch Pro capture button, Amazon Luna microphone button, Google Stadia capture button) */
+ SDL_GAMEPAD_BUTTON_RIGHT_PADDLE1, /**< Upper or primary paddle, under your right hand (e.g. Xbox Elite paddle P1) */
+ SDL_GAMEPAD_BUTTON_LEFT_PADDLE1, /**< Upper or primary paddle, under your left hand (e.g. Xbox Elite paddle P3) */
+ SDL_GAMEPAD_BUTTON_RIGHT_PADDLE2, /**< Lower or secondary paddle, under your right hand (e.g. Xbox Elite paddle P2) */
+ SDL_GAMEPAD_BUTTON_LEFT_PADDLE2, /**< Lower or secondary paddle, under your left hand (e.g. Xbox Elite paddle P4) */
+ SDL_GAMEPAD_BUTTON_TOUCHPAD, /**< PS4/PS5 touchpad button */
+ SDL_GAMEPAD_BUTTON_MISC2, /**< Additional button */
+ SDL_GAMEPAD_BUTTON_MISC3, /**< Additional button */
+ SDL_GAMEPAD_BUTTON_MISC4, /**< Additional button */
+ SDL_GAMEPAD_BUTTON_MISC5, /**< Additional button */
+ SDL_GAMEPAD_BUTTON_MISC6, /**< Additional button */
  SDL_GAMEPAD_BUTTON_COUNT
 } SDL_GamepadButton;
 ```