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

@ -53,6 +53,17 @@ typedef enum SDL_IOStatus
SDL_IO_STATUS_WRITEONLY /**< Tried to read a write-only buffer */
} SDL_IOStatus;
/**
* The function pointers that drive an SDL_IOStream.
*
* Applications can provide this struct to SDL_OpenIO() to
* create their own implementation of SDL_IOStream. This is
* not necessarily required, as SDL already offers several
* common types of I/O streams, via functions like SDL_IOFromFile()
* and SDL_IOFromMem().
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_IOStreamInterface
{
/**
@ -107,7 +118,14 @@ typedef struct SDL_IOStreamInterface
/**
* This is the read/write operation structure -- opaque, as of SDL3!
* The read/write operation structure.
*
* This operates as an opaque handle. There are several APIs to create
* various types of I/O streams, or an app can supply an
* SDL_IOStreamInterface to SDL_OpenIO() to provide their own stream
* implementation behind this struct's abstract interface.
*
* \since This struct is available since SDL 3.0.0.
*/
typedef struct SDL_IOStream SDL_IOStream;
@ -305,6 +323,9 @@ extern DECLSPEC SDL_IOStream *SDLCALL SDL_IOFromDynamicMem(void);
*
* You must free the returned pointer with SDL_CloseIO().
*
* This function makes a copy of `iface` and the caller does not need to
* keep this data around after this call.
*
* \param iface The function pointers that implement this SDL_IOStream.
* \param userdata The app-controlled pointer that is passed to iface's
* functions when called.