diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h index 0dd8279c00..dd80be77fe 100644 --- a/include/SDL3/SDL_iostream.h +++ b/include/SDL3/SDL_iostream.h @@ -45,10 +45,14 @@ extern "C" { #endif -/* SDL_IOStream status, set by a read or write operation */ +/** + * SDL_IOStream status, set by a read or write operation. + * + * \since This enum is available since SDL 3.0.0. + */ typedef enum SDL_IOStatus { - SDL_IO_STATUS_READY, /**< Everything is ready */ + SDL_IO_STATUS_READY, /**< Everything is ready (no error or EOF). */ SDL_IO_STATUS_ERROR, /**< Read or write I/O error */ SDL_IO_STATUS_EOF, /**< End of file */ SDL_IO_STATUS_NOT_READY, /**< Non blocking I/O, not ready */ @@ -305,11 +309,14 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_IOFromConstMem(const void *mem, si * allocated memory. * * This supports the following properties to provide access to the memory and - * control over allocations: - `SDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER`: a + * control over allocations: + * + * - `SDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER`: a * pointer to the internal memory of the stream. This can be set to NULL to * transfer ownership of the memory to the application, which should free the * memory with SDL_free(). If this is done, the next operation on the stream - * must be SDL_CloseIO(). - `SDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER`: + * must be SDL_CloseIO(). + * - `SDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER`: * memory will be allocated in multiples of this size, defaulting to 1024. * * \returns a pointer to a new SDL_IOStream structure, or NULL if it fails; diff --git a/include/SDL3/SDL_version.h b/include/SDL3/SDL_version.h index d6518ca5ae..fb3c16c305 100644 --- a/include/SDL3/SDL_version.h +++ b/include/SDL3/SDL_version.h @@ -39,10 +39,30 @@ extern "C" { #endif /** - * The current version of SDL + * The current major version of SDL headers. + * + * If this were SDL version 3.2.1, this value would be 3. + * + * \since This macro is available since SDL 3.0.0. */ #define SDL_MAJOR_VERSION 3 + +/** + * The current minor version of the SDL headers. + * + * If this were SDL version 3.2.1, this value would be 2. + * + * \since This macro is available since SDL 3.0.0. + */ #define SDL_MINOR_VERSION 1 + +/** + * The current micro (or patchlevel) version of the SDL headers. + * + * If this were SDL version 3.2.1, this value would be 1. + * + * \since This macro is available since SDL 3.0.0. + */ #define SDL_MICRO_VERSION 2 /**