Updated headers with latest wikiheaders tweaks.

include/SDL3/SDL_video.h

@@ -344,7 +344,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumVideoDrivers(void);
  *
  * The returned string follows the SDL_GetStringRule.
  *
- * \param index the index of a video driver
+ * \param index the index of a video driver.
  * \returns the name of the video driver with the given **index**.
  *
  * \since This function is available since SDL 3.0.0.
@@ -375,7 +375,7 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_GetCurrentVideoDriver(void);
 /**
  * Get the current system theme.
  *
- * \returns the current system theme, light, dark, or unknown
+ * \returns the current system theme, light, dark, or unknown.
  *
  * \since This function is available since SDL 3.0.0.
  */
@@ -384,7 +384,7 @@ extern SDL_DECLSPEC SDL_SystemTheme SDLCALL SDL_GetSystemTheme(void);
 /**
  * Get a list of currently connected displays.
  *
- * \param count a pointer filled in with the number of displays returned
+ * \param count a pointer filled in with the number of displays returned.
  * \returns a 0 terminated array of display instance IDs which should be freed
  *          with SDL_free(), or NULL on error; call SDL_GetError() for more
  *          details.
@@ -431,7 +431,7 @@ extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetPrimaryDisplay(void);
  *   coordinate transformations needed to conform to the requested display
  *   orientation.
  *
- * \param displayID the instance ID of the display to query
+ * \param displayID the instance ID of the display to query.
  * \returns a valid property ID on success or 0 on failure; call
  *          SDL_GetError() for more information.
  *
@@ -452,7 +452,7 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetDisplayProperties(SDL_Displa
  *
  * The returned string follows the SDL_GetStringRule.
  *
- * \param displayID the instance ID of the display to query
+ * \param displayID the instance ID of the display to query.
  * \returns the name of a display or NULL on failure; call SDL_GetError() for
  *          more information.
  *
@@ -467,8 +467,8 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_GetDisplayName(SDL_DisplayID display
  *
  * The primary display is always located at (0,0).
  *
- * \param displayID the instance ID of the display to query
- * \param rect the SDL_Rect structure filled in with the display bounds
+ * \param displayID the instance ID of the display to query.
+ * \param rect the SDL_Rect structure filled in with the display bounds.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -491,8 +491,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDisplayBounds(SDL_DisplayID displayID, SD
  * so these are good guidelines for the maximum space available to a
  * non-fullscreen window.
  *
- * \param displayID the instance ID of the display to query
- * \param rect the SDL_Rect structure filled in with the display bounds
+ * \param displayID the instance ID of the display to query.
+ * \param rect the SDL_Rect structure filled in with the display bounds.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -506,7 +506,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDisplayUsableBounds(SDL_DisplayID display
 /**
  * Get the orientation of a display when it is unrotated.
  *
- * \param displayID the instance ID of the display to query
+ * \param displayID the instance ID of the display to query.
  * \returns the SDL_DisplayOrientation enum value of the display, or
  *          `SDL_ORIENTATION_UNKNOWN` if it isn't available.
  *
@@ -519,7 +519,7 @@ extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetNaturalDisplayOrientat
 /**
  * Get the orientation of a display.
  *
- * \param displayID the instance ID of the display to query
+ * \param displayID the instance ID of the display to query.
  * \returns the SDL_DisplayOrientation enum value of the display, or
  *          `SDL_ORIENTATION_UNKNOWN` if it isn't available.
  *
@@ -537,7 +537,7 @@ extern SDL_DECLSPEC SDL_DisplayOrientation SDLCALL SDL_GetCurrentDisplayOrientat
  * display scale, which means that the user expects UI elements to be twice as
  * big on this display, to aid in readability.
  *
- * \param displayID the instance ID of the display to query
+ * \param displayID the instance ID of the display to query.
  * \returns the content scale of the display, or 0.0f on error; call
  *          SDL_GetError() for more details.
  *
@@ -559,8 +559,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetDisplayContentScale(SDL_DisplayID displ
  * - refresh rate -> highest to lowest
  * - pixel density -> lowest to highest
  *
- * \param displayID the instance ID of the display to query
- * \param count a pointer filled in with the number of display modes returned
+ * \param displayID the instance ID of the display to query.
+ * \param count a pointer filled in with the number of display modes returned.
  * \returns a NULL terminated array of display mode pointers which should be
  *          freed with SDL_free(), or NULL on error; call SDL_GetError() for
  *          more details.
@@ -581,13 +581,13 @@ extern SDL_DECLSPEC const SDL_DisplayMode **SDLCALL SDL_GetFullscreenDisplayMode
  * and finally checking the refresh rate. If all the available modes are too
  * small, then NULL is returned.
  *
- * \param displayID the instance ID of the display to query
- * \param w the width in pixels of the desired display mode
- * \param h the height in pixels of the desired display mode
+ * \param displayID the instance ID of the display to query.
+ * \param w the width in pixels of the desired display mode.
+ * \param h the height in pixels of the desired display mode.
  * \param refresh_rate the refresh rate of the desired display mode, or 0.0f
- *                     for the desktop refresh rate
- * \param include_high_density_modes Boolean to include high density modes in
- *                                   the search
+ *                     for the desktop refresh rate.
+ * \param include_high_density_modes boolean to include high density modes in
+ *                                   the search.
  * \returns a pointer to the closest display mode equal to or larger than the
  *          desired mode, or NULL on error; call SDL_GetError() for more
  *          information.
@@ -607,7 +607,7 @@ extern SDL_DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetClosestFullscreenDispl
  * function will return the previous native display mode, and not the current
  * display mode.
  *
- * \param displayID the instance ID of the display to query
+ * \param displayID the instance ID of the display to query.
  * \returns a pointer to the desktop display mode or NULL on error; call
  *          SDL_GetError() for more information.
  *
@@ -626,7 +626,7 @@ extern SDL_DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetDesktopDisplayMode(SDL
  * function will return the current display mode, and not the previous native
  * display mode.
  *
- * \param displayID the instance ID of the display to query
+ * \param displayID the instance ID of the display to query.
  * \returns a pointer to the desktop display mode or NULL on error; call
  *          SDL_GetError() for more information.
  *
@@ -640,7 +640,7 @@ extern SDL_DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetCurrentDisplayMode(SDL
 /**
  * Get the display containing a point.
  *
- * \param point the point to query
+ * \param point the point to query.
  * \returns the instance ID of the display containing the point or 0 on
  *          failure; call SDL_GetError() for more information.
  *
@@ -654,7 +654,7 @@ extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForPoint(const SDL_Point
 /**
  * Get the display primarily containing a rect.
  *
- * \param rect the rect to query
+ * \param rect the rect to query.
  * \returns the instance ID of the display entirely containing the rect or
  *          closest to the center of the rect on success or 0 on failure; call
  *          SDL_GetError() for more information.
@@ -669,7 +669,7 @@ extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForRect(const SDL_Rect *
 /**
  * Get the display associated with a window.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the instance ID of the display containing the center of the window
  *          on success or 0 on failure; call SDL_GetError() for more
  *          information.
@@ -688,7 +688,7 @@ extern SDL_DECLSPEC SDL_DisplayID SDLCALL SDL_GetDisplayForWindow(SDL_Window *wi
  * 1920x1080 and it has a high density back buffer of 3840x2160 pixels, it
  * would have a pixel density of 2.0.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the pixel density or 0.0f on failure; call SDL_GetError() for more
  *          information.
  *
@@ -712,7 +712,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowPixelDensity(SDL_Window *window);
  * updated when that setting is changed, or the window moves to a display with
  * a different scale setting.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the display scale, or 0.0f on failure; call SDL_GetError() for
  *          more information.
  *
@@ -737,7 +737,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowDisplayScale(SDL_Window *window);
  * SDL_EVENT_WINDOOW_PIXEL_SIZE_CHANGED event will be emitted with the new
  * mode dimensions.
  *
- * \param window the window to affect
+ * \param window the window to affect.
  * \param mode a pointer to the display mode to use, which can be NULL for
  *             borderless fullscreen desktop mode, or one of the fullscreen
  *             modes returned by SDL_GetFullscreenDisplayModes() to set an
@@ -756,9 +756,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowFullscreenMode(SDL_Window *window,
 /**
  * Query the display mode to use when a window is visible at fullscreen.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns a pointer to the exclusive fullscreen mode to use or NULL for
- *          borderless fullscreen desktop mode
+ *          borderless fullscreen desktop mode.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -772,8 +772,8 @@ extern SDL_DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetWindowFullscreenMode(S
  *
  * Data returned should be freed with SDL_free.
  *
- * \param window the window to query
- * \param size the size of the ICC profile
+ * \param window the window to query.
+ * \param size the size of the ICC profile.
  * \returns the raw ICC profile data on success or NULL on failure; call
  *          SDL_GetError() for more information.
  *
@@ -784,7 +784,7 @@ extern SDL_DECLSPEC void *SDLCALL SDL_GetWindowICCProfile(SDL_Window *window, si
 /**
  * Get the pixel format associated with the window.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the pixel format of the window on success or
  *          SDL_PIXELFORMAT_UNKNOWN on failure; call SDL_GetError() for more
  *          information.
@@ -841,10 +841,10 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window *window);
  * loader or link to a dynamic library version. This limitation may be removed
  * in a future version of SDL.
  *
- * \param title the title of the window, in UTF-8 encoding
- * \param w the width of the window
- * \param h the height of the window
- * \param flags 0, or one or more SDL_WindowFlags OR'd together
+ * \param title the title of the window, in UTF-8 encoding.
+ * \param w the width of the window.
+ * \param h the height of the window.
+ * \param flags 0, or one or more SDL_WindowFlags OR'd together.
  * \returns the window that was created or NULL on failure; call
  *          SDL_GetError() for more information.
  *
@@ -890,13 +890,13 @@ extern SDL_DECLSPEC SDL_Window *SDLCALL SDL_CreateWindow(const char *title, int
  * If the parent window is destroyed, any child popup windows will be
  * recursively destroyed as well.
  *
- * \param parent the parent of the window, must not be NULL
+ * \param parent the parent of the window, must not be NULL.
  * \param offset_x the x position of the popup window relative to the origin
- *                 of the parent
+ *                 of the parent.
  * \param offset_y the y position of the popup window relative to the origin
- *                 of the parent window
- * \param w the width of the window
- * \param h the height of the window
+ *                 of the parent window.
+ * \param w the width of the window.
+ * \param h the height of the window.
  * \param flags SDL_WINDOW_TOOLTIP or SDL_WINDOW_POPUP_MENU, and zero or more
  *              additional SDL_WindowFlags OR'd together.
  * \returns the window that was created or NULL on failure; call
@@ -1015,7 +1015,7 @@ extern SDL_DECLSPEC SDL_Window *SDLCALL SDL_CreatePopupWindow(SDL_Window *parent
  * set to true, then create the renderer, then show the window with
  * SDL_ShowWindow().
  *
- * \param props the properties to use
+ * \param props the properties to use.
  * \returns the window that was created or NULL on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1067,7 +1067,7 @@ extern SDL_DECLSPEC SDL_Window *SDLCALL SDL_CreateWindowWithProperties(SDL_Prope
  * The numeric ID is what SDL_WindowEvent references, and is necessary to map
  * these events to specific SDL_Window objects.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the ID of the window on success or 0 on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1083,7 +1083,7 @@ extern SDL_DECLSPEC SDL_WindowID SDLCALL SDL_GetWindowID(SDL_Window *window);
  * The numeric ID is what SDL_WindowEvent references, and is necessary to map
  * these events to specific SDL_Window objects.
  *
- * \param id the ID of the window
+ * \param id the ID of the window.
  * \returns the window associated with `id` or NULL if it doesn't exist; call
  *          SDL_GetError() for more information.
  *
@@ -1096,7 +1096,7 @@ extern SDL_DECLSPEC SDL_Window *SDLCALL SDL_GetWindowFromID(SDL_WindowID id);
 /**
  * Get parent of a window.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the parent of the window on success or NULL if the window has no
  *          parent.
  *
@@ -1204,7 +1204,7 @@ extern SDL_DECLSPEC SDL_Window *SDLCALL SDL_GetWindowParent(SDL_Window *window);
  * - `SDL_PROP_WINDOW_X11_WINDOW_NUMBER`: the X11 Window associated with the
  *   window
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns a valid property ID on success or 0 on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1250,8 +1250,8 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetWindowProperties(SDL_Window
 /**
  * Get the window flags.
  *
- * \param window the window to query
- * \returns a mask of the SDL_WindowFlags associated with `window`
+ * \param window the window to query.
+ * \returns a mask of the SDL_WindowFlags associated with `window`.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -1270,8 +1270,8 @@ extern SDL_DECLSPEC SDL_WindowFlags SDLCALL SDL_GetWindowFlags(SDL_Window *windo
  *
  * This string is expected to be in UTF-8 encoding.
  *
- * \param window the window to change
- * \param title the desired window title in UTF-8 format
+ * \param window the window to change.
+ * \param title the desired window title in UTF-8 format.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1286,7 +1286,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowTitle(SDL_Window *window, const cha
  *
  * The returned string follows the SDL_GetStringRule.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the title of the window in UTF-8 format or "" if there is no
  *          title.
  *
@@ -1299,8 +1299,8 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window *window);
 /**
  * Set the icon for a window.
  *
- * \param window the window to change
- * \param icon an SDL_Surface structure containing the icon for the window
+ * \param window the window to change.
+ * \param icon an SDL_Surface structure containing the icon for the window.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1333,11 +1333,11 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surfac
  * Additionally, as this is just a request, it can be denied by the windowing
  * system.
  *
- * \param window the window to reposition
+ * \param window the window to reposition.
  * \param x the x coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
- *          `SDL_WINDOWPOS_UNDEFINED`
+ *          `SDL_WINDOWPOS_UNDEFINED`.
  * \param y the y coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or
- *          `SDL_WINDOWPOS_UNDEFINED`
+ *          `SDL_WINDOWPOS_UNDEFINED`.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1357,9 +1357,11 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowPosition(SDL_Window *window, int x,
  * If you do not need the value for one of the positions a NULL may be passed
  * in the `x` or `y` parameter.
  *
- * \param window the window to query
- * \param x a pointer filled in with the x position of the window, may be NULL
- * \param y a pointer filled in with the y position of the window, may be NULL
+ * \param window the window to query.
+ * \param x a pointer filled in with the x position of the window, may be
+ *          NULL.
+ * \param y a pointer filled in with the y position of the window, may be
+ *          NULL.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1391,9 +1393,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowPosition(SDL_Window *window, int *x
  * content area to remain within the usable desktop bounds). Additionally, as
  * this is just a request, it can be denied by the windowing system.
  *
- * \param window the window to change
- * \param w the width of the window, must be > 0
- * \param h the height of the window, must be > 0
+ * \param window the window to change.
+ * \param w the width of the window, must be > 0.
+ * \param h the height of the window, must be > 0.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1412,9 +1414,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowSize(SDL_Window *window, int w, int
  * window is on a high pixel density display. Use SDL_GetWindowSizeInPixels()
  * or SDL_GetRenderOutputSize() to get the real client area size in pixels.
  *
- * \param window the window to query the width and height from
- * \param w a pointer filled in with the width of the window, may be NULL
- * \param h a pointer filled in with the height of the window, may be NULL
+ * \param window the window to query the width and height from.
+ * \param w a pointer filled in with the width of the window, may be NULL.
+ * \param h a pointer filled in with the height of the window, may be NULL.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1450,11 +1452,11 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowSize(SDL_Window *window, int *w, in
  * Additionally, as this is just a request, it can be denied by the windowing
  * system.
  *
- * \param window the window to change
+ * \param window the window to change.
  * \param min_aspect the minimum aspect ratio of the window, or 0.0f for no
- *                   limit
+ *                   limit.
  * \param max_aspect the maximum aspect ratio of the window, or 0.0f for no
- *                   limit
+ *                   limit.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1468,11 +1470,11 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowAspectRatio(SDL_Window *window, flo
 /**
  * Get the size of a window's client area.
  *
- * \param window the window to query the width and height from
+ * \param window the window to query the width and height from.
  * \param min_aspect a pointer filled in with the minimum aspect ratio of the
- *                   window, may be NULL
+ *                   window, may be NULL.
  * \param max_aspect a pointer filled in with the maximum aspect ratio of the
- *                   window, may be NULL
+ *                   window, may be NULL.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1498,15 +1500,15 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowAspectRatio(SDL_Window *window, flo
  * This function also returns -1 if getting the information is not supported.
  *
  * \param window the window to query the size values of the border
- *               (decorations) from
+ *               (decorations) from.
  * \param top pointer to variable for storing the size of the top border; NULL
- *            is permitted
+ *            is permitted.
  * \param left pointer to variable for storing the size of the left border;
- *             NULL is permitted
+ *             NULL is permitted.
  * \param bottom pointer to variable for storing the size of the bottom
- *               border; NULL is permitted
+ *               border; NULL is permitted.
  * \param right pointer to variable for storing the size of the right border;
- *              NULL is permitted
+ *              NULL is permitted.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1519,10 +1521,11 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowBordersSize(SDL_Window *window, int
 /**
  * Get the size of a window's client area, in pixels.
  *
- * \param window the window from which the drawable size should be queried
- * \param w a pointer to variable for storing the width in pixels, may be NULL
+ * \param window the window from which the drawable size should be queried.
+ * \param w a pointer to variable for storing the width in pixels, may be
+ *          NULL.
  * \param h a pointer to variable for storing the height in pixels, may be
- *          NULL
+ *          NULL.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1536,9 +1539,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *window, in
 /**
  * Set the minimum size of a window's client area.
  *
- * \param window the window to change
- * \param min_w the minimum width of the window, or 0 for no limit
- * \param min_h the minimum height of the window, or 0 for no limit
+ * \param window the window to change.
+ * \param min_w the minimum width of the window, or 0 for no limit.
+ * \param min_h the minimum height of the window, or 0 for no limit.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1552,11 +1555,11 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window, int
 /**
  * Get the minimum size of a window's client area.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \param w a pointer filled in with the minimum width of the window, may be
- *          NULL
+ *          NULL.
  * \param h a pointer filled in with the minimum height of the window, may be
- *          NULL
+ *          NULL.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1570,9 +1573,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window, int
 /**
  * Set the maximum size of a window's client area.
  *
- * \param window the window to change
- * \param max_w the maximum width of the window, or 0 for no limit
- * \param max_h the maximum height of the window, or 0 for no limit
+ * \param window the window to change.
+ * \param max_w the maximum width of the window, or 0 for no limit.
+ * \param max_h the maximum height of the window, or 0 for no limit.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1586,11 +1589,11 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window, int
 /**
  * Get the maximum size of a window's client area.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \param w a pointer filled in with the maximum width of the window, may be
- *          NULL
+ *          NULL.
  * \param h a pointer filled in with the maximum height of the window, may be
- *          NULL
+ *          NULL.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1610,8 +1613,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window, int
  *
  * You can't change the border state of a fullscreen window.
  *
- * \param window the window of which to change the border state
- * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border
+ * \param window the window of which to change the border state.
+ * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1630,8 +1633,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowBordered(SDL_Window *window, SDL_bo
  *
  * You can't change the resizable state of a fullscreen window.
  *
- * \param window the window of which to change the resizable state
- * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow
+ * \param window the window of which to change the resizable state.
+ * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1647,9 +1650,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowResizable(SDL_Window *window, SDL_b
  * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` flag. This
  * will bring the window to the front and keep the window above the rest.
  *
- * \param window The window of which to change the always on top state
+ * \param window the window of which to change the always on top state.
  * \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to
- *               disable
+ *               disable.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1662,7 +1665,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window, SDL
 /**
  * Show a window.
  *
- * \param window the window to show
+ * \param window the window to show.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1676,7 +1679,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_ShowWindow(SDL_Window *window);
 /**
  * Hide a window.
  *
- * \param window the window to hide
+ * \param window the window to hide.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1689,7 +1692,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_HideWindow(SDL_Window *window);
 /**
  * Raise a window above other windows and set the input focus.
  *
- * \param window the window to raise
+ * \param window the window to raise.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1717,7 +1720,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_RaiseWindow(SDL_Window *window);
  * manager. Win32 and macOS enforce the constraints when maximizing, while X11
  * and Wayland window managers may vary.
  *
- * \param window the window to maximize
+ * \param window the window to maximize.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1741,7 +1744,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_MaximizeWindow(SDL_Window *window);
  * emitted. Note that, as this is just a request, the windowing system can
  * deny the state change.
  *
- * \param window the window to minimize
+ * \param window the window to minimize.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1766,7 +1769,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_MinimizeWindow(SDL_Window *window);
  * emitted. Note that, as this is just a request, the windowing system can
  * deny the state change.
  *
- * \param window the window to restore
+ * \param window the window to restore.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1794,8 +1797,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_RestoreWindow(SDL_Window *window);
  * SDL_EVENT_WINDOW_LEAVE_FULLSCREEN event will be emitted. Note that, as this
  * is just a request, it can be denied by the windowing system.
  *
- * \param window the window to change
- * \param fullscreen SDL_TRUE for fullscreen mode, SDL_FALSE for windowed mode
+ * \param window the window to change.
+ * \param fullscreen SDL_TRUE for fullscreen mode, SDL_FALSE for windowed
+ *                   mode.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1820,7 +1824,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window *window, SDL_
  * On windowing systems where changes are immediate, this does nothing.
  *
  * \param window the window for which to wait for the pending state to be
- *               applied
+ *               applied.
  * \returns 0 on success, a positive value if the operation timed out before
  *          the window was in the requested state, or a negative error code on
  *          failure; call SDL_GetError() for more information.
@@ -1840,7 +1844,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SyncWindow(SDL_Window *window);
 /**
  * Return whether the window has a surface associated with it.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns SDL_TRUE if there is a surface associated with the window, or
  *          SDL_FALSE otherwise.
  *
@@ -1864,7 +1868,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WindowHasSurface(SDL_Window *window);
  *
  * This function is affected by `SDL_HINT_FRAMEBUFFER_ACCELERATION`.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the surface associated with the window, or NULL on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1907,7 +1911,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowSurfaceVSync(SDL_Window *window, in
 /**
  * Get VSync for the window surface.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \param vsync an int filled with the current vertical refresh sync interval.
  *              See SDL_SetWindowSurfaceVSync() for the meaning of the value.
  * \returns 0 on success or a negative error code on failure; call
@@ -1927,7 +1931,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowSurfaceVSync(SDL_Window *window, in
  *
  * This function is equivalent to the SDL 1.2 API SDL_Flip().
  *
- * \param window the window to update
+ * \param window the window to update.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1951,10 +1955,10 @@ extern SDL_DECLSPEC int SDLCALL SDL_UpdateWindowSurface(SDL_Window *window);
  * update more of the screen (or all of the screen!), depending on what method
  * SDL uses to send pixels to the system.
  *
- * \param window the window to update
+ * \param window the window to update.
  * \param rects an array of SDL_Rect structures representing areas of the
- *              surface to copy, in pixels
- * \param numrects the number of rectangles
+ *              surface to copy, in pixels.
+ * \param numrects the number of rectangles.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1968,7 +1972,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *window,
 /**
  * Destroy the surface associated with the window.
  *
- * \param window the window to update
+ * \param window the window to update.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -1998,8 +2002,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_DestroyWindowSurface(SDL_Window *window);
  * If the caller enables a grab while another window is currently grabbed, the
  * other window loses its grab in favor of the caller's window.
  *
- * \param window The window for which the keyboard grab mode should be set.
- * \param grabbed This is SDL_TRUE to grab keyboard, and SDL_FALSE to release.
+ * \param window the window for which the keyboard grab mode should be set.
+ * \param grabbed this is SDL_TRUE to grab keyboard, and SDL_FALSE to release.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2015,8 +2019,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *window, SD
  *
  * Mouse grab confines the mouse cursor to the window.
  *
- * \param window The window for which the mouse grab mode should be set.
- * \param grabbed This is SDL_TRUE to grab mouse, and SDL_FALSE to release.
+ * \param window the window for which the mouse grab mode should be set.
+ * \param grabbed this is SDL_TRUE to grab mouse, and SDL_FALSE to release.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2030,7 +2034,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowMouseGrab(SDL_Window *window, SDL_b
 /**
  * Get a window's keyboard grab mode.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.
  *
  * \since This function is available since SDL 3.0.0.
@@ -2042,7 +2046,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowKeyboardGrab(SDL_Window *windo
 /**
  * Get a window's mouse grab mode.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise.
  *
  * \since This function is available since SDL 3.0.0.
@@ -2069,8 +2073,8 @@ extern SDL_DECLSPEC SDL_Window *SDLCALL SDL_GetGrabbedWindow(void);
  * Note that this does NOT grab the cursor, it only defines the area a cursor
  * is restricted to when the window has mouse focus.
  *
- * \param window The window that will be associated with the barrier.
- * \param rect A rectangle area in window-relative coordinates. If NULL the
+ * \param window the window that will be associated with the barrier.
+ * \param rect a rectangle area in window-relative coordinates. If NULL the
  *             barrier for the specified window will be destroyed.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
@@ -2085,7 +2089,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowMouseRect(SDL_Window *window, const
 /**
  * Get the mouse confinement rectangle of a window.
  *
- * \param window The window to query
+ * \param window the window to query.
  * \returns a pointer to the mouse confinement rectangle of a window, or NULL
  *          if there isn't one.
  *
@@ -2103,8 +2107,8 @@ extern SDL_DECLSPEC const SDL_Rect *SDLCALL SDL_GetWindowMouseRect(SDL_Window *w
  *
  * This function also returns -1 if setting the opacity isn't supported.
  *
- * \param window the window which will be made transparent or opaque
- * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque)
+ * \param window the window which will be made transparent or opaque.
+ * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque).
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2124,8 +2128,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float o
  *
  * This function also returns -1 if an invalid window was provided.
  *
- * \param window the window to get the current opacity value from
- * \param out_opacity the float filled in (0.0f - transparent, 1.0f - opaque)
+ * \param window the window to get the current opacity value from.
+ * \param out_opacity the float filled in (0.0f - transparent, 1.0f - opaque).
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2145,8 +2149,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetWindowOpacity(SDL_Window *window, float *
  * Setting a window as modal to a parent that is a descendent of the modal
  * window results in undefined behavior.
  *
- * \param modal_window the window that should be set modal
- * \param parent_window the parent window for the modal window
+ * \param modal_window the window that should be set modal.
+ * \param parent_window the parent window for the modal window.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2161,7 +2165,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowModalFor(SDL_Window *modal_window,
  * this with caution, as you might give focus to a window that is completely
  * obscured by other windows.
  *
- * \param window the window that should get the input focus
+ * \param window the window that should get the input focus.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2174,9 +2178,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowInputFocus(SDL_Window *window);
 /**
  * Set whether the window may have input focus.
  *
- * \param window the window to set focusable state
+ * \param window the window to set focusable state.
  * \param focusable SDL_TRUE to allow input focus, SDL_FALSE to not allow
- *                  input focus
+ *                  input focus.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2196,11 +2200,11 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowFocusable(SDL_Window *window, SDL_b
  * On platforms or desktops where this is unsupported, this function does
  * nothing.
  *
- * \param window the window for which the menu will be displayed
+ * \param window the window for which the menu will be displayed.
  * \param x the x coordinate of the menu, relative to the origin (top-left) of
- *          the client area
+ *          the client area.
  * \param y the y coordinate of the menu, relative to the origin (top-left) of
- *          the client area
+ *          the client area.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2232,9 +2236,9 @@ typedef enum SDL_HitTestResult
 /**
  * Callback used for hit-testing.
  *
- * \param win the SDL_Window where hit-testing was set on
- * \param area an SDL_Point which should be hit-tested
- * \param data what was passed as `callback_data` to SDL_SetWindowHitTest()
+ * \param win the SDL_Window where hit-testing was set on.
+ * \param area an SDL_Point which should be hit-tested.
+ * \param data what was passed as `callback_data` to SDL_SetWindowHitTest().
  * \returns an SDL_HitTestResult value.
  *
  * \sa SDL_SetWindowHitTest
@@ -2275,9 +2279,9 @@ typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win,
  * can fire at any time, you should try to keep your callback efficient,
  * devoid of allocations, etc.
  *
- * \param window the window to set hit-testing on
- * \param callback the function to call when doing a hit-test
- * \param callback_data an app-defined void pointer passed to **callback**
+ * \param window the window to set hit-testing on.
+ * \param callback the function to call when doing a hit-test.
+ * \param callback_data an app-defined void pointer passed to **callback**.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2299,9 +2303,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SDL_Hit
  *
  * The window must have been created with the SDL_WINDOW_TRANSPARENT flag.
  *
- * \param window the window
+ * \param window the window.
  * \param shape the surface representing the shape of the window, or NULL to
- *              remove any current shape
+ *              remove any current shape.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2312,8 +2316,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_Surfa
 /**
  * Request a window to demand attention from the user.
  *
- * \param window the window to be flashed
- * \param operation the operation to perform
+ * \param window the window to be flashed.
+ * \param operation the operation to perform.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2330,7 +2334,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_FlashWindow(SDL_Window *window, SDL_FlashOpe
  * If `window` is NULL, this function will return immediately after setting
  * the SDL error message to "Invalid window". See SDL_GetError().
  *
- * \param window the window to destroy
+ * \param window the window to destroy.
  *
  * \since This function is available since SDL 3.0.0.
  *
@@ -2407,7 +2411,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_DisableScreenSaver(void);
  * program from the dynamic library using SDL_GL_GetProcAddress().
  *
  * \param path the platform dependent OpenGL library name, or NULL to open the
- *             default OpenGL library
+ *             default OpenGL library.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2459,7 +2463,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
  *   code. This will ensure the proper calling convention is followed on
  *   platforms where this matters (Win32) thereby avoiding stack corruption.
  *
- * \param proc the name of an OpenGL function
+ * \param proc the name of an OpenGL function.
  * \returns a pointer to the named OpenGL function. The returned pointer
  *          should be cast to the appropriate function signature.
  *
@@ -2478,7 +2482,7 @@ extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_GL_GetProcAddress(const char
  * points for EGL functions. This is useful to provide to an EGL API and
  * extension loader.
  *
- * \param proc the name of an EGL function
+ * \param proc the name of an EGL function.
  * \returns a pointer to the named EGL function. The returned pointer should
  *          be cast to the appropriate function signature.
  *
@@ -2511,7 +2515,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_GL_UnloadLibrary(void);
  * context and save that information somewhere instead of calling the function
  * every time you need to know.
  *
- * \param extension the name of the extension to check
+ * \param extension the name of the extension to check.
  * \returns SDL_TRUE if the extension is supported, SDL_FALSE otherwise.
  *
  * \since This function is available since SDL 3.0.0.
@@ -2536,8 +2540,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void);
  * SDL_GL_GetAttribute() to check the values after creating the OpenGL
  * context, since the values obtained can differ from the requested ones.
  *
- * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to set
- * \param value the desired value for the attribute
+ * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to
+ *             set.
+ * \param value the desired value for the attribute.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2551,8 +2556,9 @@ extern SDL_DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
 /**
  * Get the actual value for an attribute from the current context.
  *
- * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to get
- * \param value a pointer filled in with the current value of `attr`
+ * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to
+ *             get.
+ * \param value a pointer filled in with the current value of `attr`.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2574,7 +2580,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int *value)
  *
  * SDL_GLContext is an alias for `void *`. It's opaque to the application.
  *
- * \param window the window to associate with the context
+ * \param window the window to associate with the context.
  * \returns the OpenGL context associated with `window` or NULL on error; call
  *          SDL_GetError() for more details.
  *
@@ -2590,8 +2596,8 @@ extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *windo
  *
  * The context must have been created with a compatible window.
  *
- * \param window the window to associate with the context
- * \param context the OpenGL context to associate with the window
+ * \param window the window to associate with the context.
+ * \param context the OpenGL context to associate with the window.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2646,7 +2652,7 @@ extern SDL_DECLSPEC SDL_EGLConfig SDLCALL SDL_EGL_GetCurrentEGLConfig(void);
 /**
  * Get the EGL surface associated with the window.
  *
- * \param window the window to query
+ * \param window the window to query.
  * \returns the EGLSurface pointer associated with the window, or NULL on
  *          failure.
  *
@@ -2667,11 +2673,11 @@ extern SDL_DECLSPEC SDL_EGLSurface SDLCALL SDL_EGL_GetWindowEGLSurface(SDL_Windo
  *
  * NOTE: These callback pointers will be reset after SDL_GL_ResetAttributes.
  *
- * \param platformAttribCallback Callback for attributes to pass to
+ * \param platformAttribCallback callback for attributes to pass to
  *                               eglGetPlatformDisplay.
- * \param surfaceAttribCallback Callback for attributes to pass to
+ * \param surfaceAttribCallback callback for attributes to pass to
  *                              eglCreateSurface.
- * \param contextAttribCallback Callback for attributes to pass to
+ * \param contextAttribCallback callback for attributes to pass to
  *                              eglCreateContext.
  *
  * \since This function is available since SDL 3.0.0.
@@ -2699,7 +2705,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_EGL_SetEGLAttributeCallbacks(SDL_EGLAttribA
  * https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync
  *
  * \param interval 0 for immediate updates, 1 for updates synchronized with
- *                 the vertical retrace, -1 for adaptive vsync
+ *                 the vertical retrace, -1 for adaptive vsync.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2715,10 +2721,10 @@ extern SDL_DECLSPEC int SDLCALL SDL_GL_SetSwapInterval(int interval);
  * If the system can't determine the swap interval, or there isn't a valid
  * current context, this function will set *interval to 0 as a safe default.
  *
- * \param interval Output interval value. 0 if there is no vertical retrace
+ * \param interval output interval value. 0 if there is no vertical retrace
  *                 synchronization, 1 if the buffer swap is synchronized with
  *                 the vertical retrace, and -1 if late swaps happen
- *                 immediately instead of waiting for the next retrace
+ *                 immediately instead of waiting for the next retrace.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2738,7 +2744,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(int *interval);
  * glBindFramebuffer(), this is the default and you won't have to do anything
  * extra.
  *
- * \param window the window to change
+ * \param window the window to change.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
@@ -2749,7 +2755,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GL_SwapWindow(SDL_Window *window);
 /**
  * Delete an OpenGL context.
  *
- * \param context the OpenGL context to be deleted
+ * \param context the OpenGL context to be deleted.
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *