Sync SDL2 wiki -> header

libsdl-org · Jun 20, 2024 · c1d10c3 · c1d10c3
1 parent 194d72b
commit c1d10c3
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/include/SDL_hints.h b/include/SDL_hints.h
@@ -1655,13 +1655,16 @@ extern "C" {
 #define SDL_HINT_MOUSE_RELATIVE_WARP_MOTION  "SDL_MOUSE_RELATIVE_WARP_MOTION"
 
 /**
- *  \brief  A variable controlling whether the hardware cursor stays visible when relative mode is active.
+ * A variable controlling whether the hardware cursor stays visible when
+ * relative mode is active.
  *
- *  This variable can be set to the following values:
- *    "0"       - The cursor will be hidden while relative mode is active (default)
- *    "1"       - The cursor will remain visible while relative mode is active
+ * This variable can be set to the following values: "0" - The cursor will be
+ * hidden while relative mode is active (default) "1" - The cursor will remain
+ * visible while relative mode is active
  *
- *  Note that for systems without raw hardware inputs, relative mode is implemented using warping, so the hardware cursor will visibly warp between frames if this is enabled on those systems.
+ * Note that for systems without raw hardware inputs, relative mode is
+ * implemented using warping, so the hardware cursor will visibly warp between
+ * frames if this is enabled on those systems.
  */
 #define SDL_HINT_MOUSE_RELATIVE_CURSOR_VISIBLE  "SDL_MOUSE_RELATIVE_CURSOR_VISIBLE"