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

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
No known key found for this signature in database
GPG key ID: FA148B892AB48044
45 changed files with 1565 additions and 833 deletions

View file

@ -122,7 +122,7 @@ extern DECLSPEC void SDLCALL SDL_ClearError(void);
#define SDL_OutOfMemory() SDL_Error(SDL_ENOMEM)
#define SDL_Unsupported() SDL_Error(SDL_UNSUPPORTED)
#define SDL_InvalidParamError(param) SDL_SetError("Parameter '%s' is invalid", (param))
typedef enum
typedef enum SDL_errorcode
{
SDL_ENOMEM,
SDL_EFREAD,
@ -133,7 +133,7 @@ typedef enum
} SDL_errorcode;
/**
* SDL_Error()
* Set an SDL error from a list of error codes.
*
* \param code Error code
* \returns unconditionally -1.