Updated headers with latest wikiheaders tweaks.

2024-06-14 02:09:55 -04:00
parent c0c0c64a1d
commit 51902d4ac5
44 changed files with 1699 additions and 1686 deletions
--- a/include/SDL3/SDL_iostream.h
+++ b/include/SDL3/SDL_iostream.h
@@ -221,7 +221,7 @@ typedef struct SDL_IOStream SDL_IOStream;
 *   the filesystem. If SDL used some other method to access the filesystem,
 *   this property will not be set.
 *
- * \param file a UTF-8 string representing the filename to open
+ * \param file a UTF-8 string representing the filename to open.
 * \param mode an ASCII string representing the mode to be used for opening
 *             the file.
 * \returns a pointer to the SDL_IOStream structure that is created, or NULL
@@ -256,8 +256,8 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_IOFromFile(const char *file, const
 * buffer, you should use SDL_IOFromConstMem() with a read-only buffer of
 * memory instead.
 *
- * \param mem a pointer to a buffer to feed an SDL_IOStream stream
- * \param size the buffer size, in bytes
+ * \param mem a pointer to a buffer to feed an SDL_IOStream stream.
+ * \param size the buffer size, in bytes.
 * \returns a pointer to a new SDL_IOStream structure, or NULL if it fails;
 *          call SDL_GetError() for more information.
 *
@@ -289,8 +289,8 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_IOFromMem(void *mem, size_t size);
 * If you need to write to a memory buffer, you should use SDL_IOFromMem()
 * with a writable buffer of memory instead.
 *
- * \param mem a pointer to a read-only buffer to feed an SDL_IOStream stream
- * \param size the buffer size, in bytes
+ * \param mem a pointer to a read-only buffer to feed an SDL_IOStream stream.
+ * \param size the buffer size, in bytes.
 * \returns a pointer to a new SDL_IOStream structure, or NULL if it fails;
 *          call SDL_GetError() for more information.
 *
@@ -351,8 +351,8 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_IOFromDynamicMem(void);
 * 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
+ * \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.
 * \returns a pointer to the allocated memory on success, or NULL on failure;
 *          call SDL_GetError() for more information.
@@ -377,7 +377,7 @@ extern SDL_DECLSPEC SDL_IOStream *SDLCALL SDL_OpenIO(const SDL_IOStreamInterface
 * Note that if this fails to flush the stream to disk, this function reports
 * an error, but the SDL_IOStream is still invalid once this function returns.
 *
- * \param context SDL_IOStream structure to close
+ * \param context SDL_IOStream structure to close.
 * \returns 0 on success or a negative error code on failure; call
 *          SDL_GetError() for more information.
 *
@@ -390,7 +390,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_CloseIO(SDL_IOStream *context);
 /**
 * Get the properties associated with an SDL_IOStream.
 *
- * \param context a pointer to an SDL_IOStream structure
+ * \param context a pointer to an SDL_IOStream structure.
 * \returns a valid property ID on success or 0 on failure; call
 *          SDL_GetError() for more information.
 *
@@ -425,7 +425,7 @@ extern SDL_DECLSPEC SDL_IOStatus SDLCALL SDL_GetIOStatus(SDL_IOStream *context);
 /**
 * Use this function to get the size of the data stream in an SDL_IOStream.
 *
- * \param context the SDL_IOStream to get the size of the data stream from
+ * \param context the SDL_IOStream to get the size of the data stream from.
 * \returns the size of the data stream in the SDL_IOStream on success or a
 *          negative error code on failure; call SDL_GetError() for more
 *          information.
@@ -447,11 +447,11 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetIOSize(SDL_IOStream *context);
 *
 * If this stream can not seek, it will return -1.
 *
- * \param context a pointer to an SDL_IOStream structure
+ * \param context a pointer to an SDL_IOStream structure.
 * \param offset an offset in bytes, relative to `whence` location; can be
- *               negative
+ *               negative.
 * \param whence any of `SDL_IO_SEEK_SET`, `SDL_IO_SEEK_CUR`,
- *               `SDL_IO_SEEK_END`
+ *               `SDL_IO_SEEK_END`.
 * \returns the final offset in the data stream after the seek or a negative
 *          error code on failure; call SDL_GetError() for more information.
 *
@@ -469,7 +469,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_SeekIO(SDL_IOStream *context, Sint64 offs
 * simplify application development.
 *
 * \param context an SDL_IOStream data stream object from which to get the
- *                current offset
+ *                current offset.
 * \returns the current offset in the stream, or -1 if the information can not
 *          be determined.
 *
@@ -488,8 +488,8 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_TellIO(SDL_IOStream *context);
 * determine if there was an error or all data was read, call
 * SDL_GetIOStatus().
 *
- * \param context a pointer to an SDL_IOStream structure
- * \param ptr a pointer to a buffer to read data into
+ * \param context a pointer to an SDL_IOStream structure.
+ * \param ptr a pointer to a buffer to read data into.
 * \param size the number of bytes to read from the data source.
 * \returns the number of bytes read, or 0 on end of file or other error.
 *
@@ -514,9 +514,9 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_ReadIO(SDL_IOStream *context, void *ptr,
 * recoverable, such as a non-blocking write that can simply be retried later,
 * or a fatal error.
 *
- * \param context a pointer to an SDL_IOStream structure
- * \param ptr a pointer to a buffer containing data to write
- * \param size the number of bytes to write
+ * \param context a pointer to an SDL_IOStream structure.
+ * \param ptr a pointer to a buffer containing data to write.
+ * \param size the number of bytes to write.
 * \returns the number of bytes written, which will be less than `size` on
 *          error; call SDL_GetError() for more information.
 *
@@ -534,10 +534,10 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_WriteIO(SDL_IOStream *context, const void
 *
 * This function does formatted printing to the stream.
 *
- * \param context a pointer to an SDL_IOStream structure
- * \param fmt a printf() style format string
+ * \param context a pointer to an SDL_IOStream structure.
+ * \param fmt a printf() style format string.
 * \param ... additional parameters matching % tokens in the `fmt` string, if
- *            any
+ *            any.
 * \returns the number of bytes written, or 0 on error; call SDL_GetError()
 *          for more information.
 *
@@ -553,9 +553,9 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_IOprintf(SDL_IOStream *context, SDL_PRINT
 *
 * This function does formatted printing to the stream.
 *
- * \param context a pointer to an SDL_IOStream structure
- * \param fmt a printf() style format string
- * \param ap a variable argument list
+ * \param context a pointer to an SDL_IOStream structure.
+ * \param fmt a printf() style format string.
+ * \param ap a variable argument list.
 * \returns the number of bytes written, or 0 on error; call SDL_GetError()
 *          for more information.
 *
@@ -575,10 +575,10 @@ extern SDL_DECLSPEC size_t SDLCALL SDL_IOvprintf(SDL_IOStream *context, SDL_PRIN
 *
 * The data should be freed with SDL_free().
 *
- * \param src the SDL_IOStream to read all available data from
- * \param datasize if not NULL, will store the number of bytes read
+ * \param src the SDL_IOStream to read all available data from.
+ * \param datasize if not NULL, will store the number of bytes read.
 * \param closeio if SDL_TRUE, calls SDL_CloseIO() on `src` before returning,
- *                even in the case of an error
+ *                even in the case of an error.
 * \returns the data, or NULL if there was an error.
 *
 * \since This function is available since SDL 3.0.0.
@@ -596,8 +596,8 @@ extern SDL_DECLSPEC void *SDLCALL SDL_LoadFile_IO(SDL_IOStream *src, size_t *dat
 *
 * The data should be freed with SDL_free().
 *
- * \param file the path to read all available data from
- * \param datasize if not NULL, will store the number of bytes read
+ * \param file the path to read all available data from.
+ * \param datasize if not NULL, will store the number of bytes read.
 * \returns the data, or NULL if there was an error.
 *
 * \since This function is available since SDL 3.0.0.
@@ -616,8 +616,8 @@ extern SDL_DECLSPEC void *SDLCALL SDL_LoadFile(const char *file, size_t *datasiz
 /**
 * Use this function to read a byte from an SDL_IOStream.
 *
- * \param src the SDL_IOStream to read from
- * \param value a pointer filled in with the data read
+ * \param src the SDL_IOStream to read from.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError()
 *          for more information.
 *
@@ -628,8 +628,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadU8(SDL_IOStream *src, Uint8 *value)
 /**
 * Use this function to read a signed byte from an SDL_IOStream.
 *
- * \param src the SDL_IOStream to read from
- * \param value a pointer filled in with the data read
+ * \param src the SDL_IOStream to read from.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError()
 *          for more information.
 *
@@ -644,8 +644,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadS8(SDL_IOStream *src, Sint8 *value)
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -660,8 +660,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadU16LE(SDL_IOStream *src, Uint16 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -676,8 +676,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadS16LE(SDL_IOStream *src, Sint16 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -692,8 +692,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadU16BE(SDL_IOStream *src, Uint16 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -708,8 +708,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadS16BE(SDL_IOStream *src, Sint16 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -724,8 +724,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadU32LE(SDL_IOStream *src, Uint32 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -740,8 +740,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadS32LE(SDL_IOStream *src, Sint32 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -756,8 +756,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadU32BE(SDL_IOStream *src, Uint32 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -772,8 +772,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadS32BE(SDL_IOStream *src, Sint32 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -788,8 +788,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadU64LE(SDL_IOStream *src, Uint64 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -804,8 +804,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadS64LE(SDL_IOStream *src, Sint64 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -820,8 +820,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadU64BE(SDL_IOStream *src, Uint64 *va
 * SDL byteswaps the data only if necessary, so the data returned will be in
 * the native byte order.
 *
- * \param src the stream from which to read data
- * \param value a pointer filled in with the data read
+ * \param src the stream from which to read data.
+ * \param value a pointer filled in with the data read.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -840,8 +840,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadS64BE(SDL_IOStream *src, Sint64 *va
 /**
 * Use this function to write a byte to an SDL_IOStream.
 *
- * \param dst the SDL_IOStream to write to
- * \param value the byte value to write
+ * \param dst the SDL_IOStream to write to.
+ * \param value the byte value to write.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -852,8 +852,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteU8(SDL_IOStream *dst, Uint8 value)
 /**
 * Use this function to write a signed byte to an SDL_IOStream.
 *
- * \param dst the SDL_IOStream to write to
- * \param value the byte value to write
+ * \param dst the SDL_IOStream to write to.
+ * \param value the byte value to write.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -869,8 +869,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteS8(SDL_IOStream *dst, Sint8 value)
 * specifies native format, and the data written will be in little-endian
 * format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -886,8 +886,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteU16LE(SDL_IOStream *dst, Uint16 va
 * specifies native format, and the data written will be in little-endian
 * format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -902,8 +902,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteS16LE(SDL_IOStream *dst, Sint16 va
 * SDL byteswaps the data only if necessary, so the application always
 * specifies native format, and the data written will be in big-endian format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -918,8 +918,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteU16BE(SDL_IOStream *dst, Uint16 va
 * SDL byteswaps the data only if necessary, so the application always
 * specifies native format, and the data written will be in big-endian format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -935,8 +935,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteS16BE(SDL_IOStream *dst, Sint16 va
 * specifies native format, and the data written will be in little-endian
 * format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -952,8 +952,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteU32LE(SDL_IOStream *dst, Uint32 va
 * specifies native format, and the data written will be in little-endian
 * format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -968,8 +968,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteS32LE(SDL_IOStream *dst, Sint32 va
 * SDL byteswaps the data only if necessary, so the application always
 * specifies native format, and the data written will be in big-endian format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -984,8 +984,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteU32BE(SDL_IOStream *dst, Uint32 va
 * SDL byteswaps the data only if necessary, so the application always
 * specifies native format, and the data written will be in big-endian format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -1001,8 +1001,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteS32BE(SDL_IOStream *dst, Sint32 va
 * specifies native format, and the data written will be in little-endian
 * format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -1018,8 +1018,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteU64LE(SDL_IOStream *dst, Uint64 va
 * specifies native format, and the data written will be in little-endian
 * format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -1034,8 +1034,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteS64LE(SDL_IOStream *dst, Sint64 va
 * SDL byteswaps the data only if necessary, so the application always
 * specifies native format, and the data written will be in big-endian format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *
@@ -1050,8 +1050,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteU64BE(SDL_IOStream *dst, Uint64 va
 * SDL byteswaps the data only if necessary, so the application always
 * specifies native format, and the data written will be in big-endian format.
 *
- * \param dst the stream to which data will be written
- * \param value the data to be written, in native format
+ * \param dst the stream to which data will be written.
+ * \param value the data to be written, in native format.
 * \returns SDL_TRUE on successful write, SDL_FALSE on failure; call
 *          SDL_GetError() for more information.
 *