Browse Source

Sync SDL3 wiki -> header

SDL Wiki Bot 9 months ago
parent
commit
f787790243
2 changed files with 9 additions and 4 deletions
  1. 7 3
      include/SDL3/SDL_events.h
  2. 2 1
      include/SDL3/SDL_keyboard.h

+ 7 - 3
include/SDL3/SDL_events.h

@@ -315,12 +315,16 @@ typedef struct SDL_KeyboardDeviceEvent
 /**
  * Keyboard button event structure (event.key.*)
  *
- * The `key` is the base SDL_Keycode generated by pressing the `scancode` using the current keyboard layout, applying any options specified in SDL_HINT_KEYCODE_OPTIONS. You can get the SDL_Keycode corresponding to the event scancode and modifiers directly from the keyboard layout, bypassing SDL_HINT_KEYCODE_OPTIONS, by calling SDL_GetKeyFromScancode().
+ * The `key` is the base SDL_Keycode generated by pressing the `scancode`
+ * using the current keyboard layout, applying any options specified in
+ * SDL_HINT_KEYCODE_OPTIONS. You can get the SDL_Keycode corresponding to the
+ * event scancode and modifiers directly from the keyboard layout, bypassing
+ * SDL_HINT_KEYCODE_OPTIONS, by calling SDL_GetKeyFromScancode().
+ *
+ * \since This struct is available since SDL 3.0.0.
  *
  * \sa SDL_GetKeyFromScancode
  * \sa SDL_HINT_KEYCODE_OPTIONS
- *
- * \since This struct is available since SDL 3.0.0.
  */
 typedef struct SDL_KeyboardEvent
 {

+ 2 - 1
include/SDL3/SDL_keyboard.h

@@ -321,7 +321,8 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromName(const char *nam
 /**
  * Get a human-readable name for a key.
  *
- * Both lowercase and uppercase alphabetic keycodes have uppercase names, e.g. SDL_Keycode 'a' and 'A' both have the name "A".
+ * Both lowercase and uppercase alphabetic keycodes have uppercase names, e.g.
+ * SDL_Keycode 'a' and 'A' both have the name "A".
  *
  * The returned string follows the SDL_GetStringRule.
  *