From 1e81424b3d0f09d9b39856b5921fe1afa174f7d7 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <icculus-sdlwikibot@icculus.org>
Date: Sat, 22 Jun 2024 05:06:38 +0000
Subject: [PATCH] Sync SDL3 wiki -> header

---
 include/SDL3/SDL_keyboard.h | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)

diff --git a/include/SDL3/SDL_keyboard.h b/include/SDL3/SDL_keyboard.h
index 971706f38b..83576e208f 100644
--- a/include/SDL3/SDL_keyboard.h
+++ b/include/SDL3/SDL_keyboard.h
@@ -192,7 +192,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetModState(SDL_Keymod modstate);
  * See SDL_Keycode for details.
  *
  * \param scancode the desired SDL_Scancode to query.
- * \param modstate the modifier state to use when translating the scancode to a keycode.
+ * \param modstate the modifier state to use when translating the scancode to
+ *                 a keycode.
  * \returns the SDL_Keycode that corresponds to the given SDL_Scancode.
  *
  * \since This function is available since SDL 3.0.0.
@@ -209,7 +210,8 @@ extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetDefaultKeyFromScancode(SDL_Scanco
  * See SDL_Keycode for details.
  *
  * \param scancode the desired SDL_Scancode to query.
- * \param modstate the modifier state to use when translating the scancode to a keycode.
+ * \param modstate the modifier state to use when translating the scancode to
+ *                 a keycode.
  * \returns the SDL_Keycode that corresponds to the given SDL_Scancode.
  *
  * \since This function is available since SDL 3.0.0.
@@ -221,12 +223,15 @@ extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetDefaultKeyFromScancode(SDL_Scanco
 extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode, SDL_Keymod modstate);
 
 /**
- * Get the scancode corresponding to the given key code according to a default en_US keyboard layout.
+ * Get the scancode corresponding to the given key code according to a default
+ * en_US keyboard layout.
  *
- * Note that there may be multiple scancode+modifier states that can generate this keycode, this will just return the first one found.
+ * Note that there may be multiple scancode+modifier states that can generate
+ * this keycode, this will just return the first one found.
  *
  * \param key the desired SDL_Keycode to query.
- * \param modstate a pointer to the modifier state that would be used when the scancode generates this key, may be NULL.
+ * \param modstate a pointer to the modifier state that would be used when the
+ *                 scancode generates this key, may be NULL.
  * \returns the SDL_Scancode that corresponds to the given SDL_Keycode.
  *
  * \since This function is available since SDL 3.0.0.
@@ -240,10 +245,12 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetDefaultScancodeFromKey(SDL_Keyco
  * Get the scancode corresponding to the given key code according to the
  * current keyboard layout.
  *
- * Note that there may be multiple scancode+modifier states that can generate this keycode, this will just return the first one found.
+ * Note that there may be multiple scancode+modifier states that can generate
+ * this keycode, this will just return the first one found.
  *
  * \param key the desired SDL_Keycode to query.
- * \param modstate a pointer to the modifier state that would be used when the scancode generates this key, may be NULL.
+ * \param modstate a pointer to the modifier state that would be used when the
+ *                 scancode generates this key, may be NULL.
  * \returns the SDL_Scancode that corresponds to the given SDL_Keycode.
  *
  * \since This function is available since SDL 3.0.0.
@@ -258,7 +265,9 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key,
  * Set a human-readable name for a scancode.
  *
  * \param scancode the desired SDL_Scancode.
- * \param name the name to use for the scancode, encoded as UTF-8. The string is not copied, so the pointer given to this function must stay valid while SDL is being used.
+ * \param name the name to use for the scancode, encoded as UTF-8. The string
+ *             is not copied, so the pointer given to this function must stay
+ *             valid while SDL is being used.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *