mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-12-07 23:22:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: A ton of little documentation tweaks, fixes, and improvements.

Browse Source 
This is just stuff I noticed while working on the wikiheaders updates. A
thorough pass over all the docs would not be terrible, and maybe a simple
script to check for consistency (does everything have a `\since` on it? etc)
might be nice, too.
This commit is contained in:
Ryan C. Gordon
2024-04-08 22:36:57 -04:00
parent 645073961d
commit ad090d2444
45 changed files with 1565 additions and 833 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/SDL3/SDL_rect.h
View File

@@ -38,10 +38,12 @@ extern "C" {
#endif
/**
* The structure that defines a point (integer)
* The structure that defines a point (using integers).
*
* \sa SDL_GetRectEnclosingPoints
* \sa SDL_PointInRect
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_Point
{
@@ -50,10 +52,12 @@ typedef struct SDL_Point
} SDL_Point;
/**
* The structure that defines a point (floating point)
* The structure that defines a point (using floating point values).
*
* \sa SDL_GetRectEnclosingPointsFloat
* \sa SDL_PointInRectFloat
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_FPoint
{
@@ -63,7 +67,7 @@ typedef struct SDL_FPoint
/**
* A rectangle, with the origin at the upper left (integer).
* A rectangle, with the origin at the upper left (using integers).
*
* \sa SDL_RectEmpty
* \sa SDL_RectsEqual
@@ -72,6 +76,8 @@ typedef struct SDL_FPoint
* \sa SDL_GetRectAndLineIntersection
* \sa SDL_GetRectUnion
* \sa SDL_GetRectEnclosingPoints
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_Rect
{
@@ -81,7 +87,7 @@ typedef struct SDL_Rect
/**
* A rectangle, with the origin at the upper left (floating point).
* A rectangle, with the origin at the upper left (using floating point values).
*
* \sa SDL_RectEmptyFloat
* \sa SDL_RectsEqualFloat
@@ -92,6 +98,8 @@ typedef struct SDL_Rect
* \sa SDL_GetRectUnionFloat
* \sa SDL_GetRectEnclosingPointsFloat
* \sa SDL_PointInRectFloat
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_FRect
{