SDL Wiki Bot
454c85ad51
Sync SDL3 wiki -> header
2024-08-04 17:39:54 +00:00
Sam Lantinga
6da4278d37
Clarify how to check for EOF in SDL_ReadIO() documentation.
...
Fixes https://github.com/libsdl-org/SDL/issues/8564
2024-08-04 10:37:51 -07:00
SDL Wiki Bot
975457cfb6
Sync SDL3 wiki -> header
2024-07-19 19:23:24 +00:00
Sam Lantinga
637e9700dd
Standardize placement of '*' in function declarations
...
Implemented using these sed commands on the headers:
sed -E -i'' '/SDLCALL|;/ s,([a-z])\* ,\1 *,g' *
sed -E -i'' 's,(\(.*[^\*])\* ([a-z])(.*\)),\1*\2\3,g' *
sed -E -i'' 's,\*const,* const,g' *
sed -E -i'' 's,\*SDLCALL,* SDLCALL,g' *
sed -E -i'' 's,void\(,void (,g' *
git checkout *gl*
2024-07-19 12:22:03 -07:00
Sam Lantinga
217330a7b3
Made return value descriptions more consistent across the API
2024-07-19 12:22:03 -07:00
Sam Lantinga
5bf6bc4d7d
Renamed SDL_Get/SetProperty() to SDL_Get/SetPointerProperty()
...
This is consistent with the naming for the functions that affect other data types
Fixes https://github.com/libsdl-org/SDL/issues/10241
2024-07-12 10:41:02 -07:00
Ryan C. Gordon
51902d4ac5
Updated headers with latest wikiheaders tweaks.
2024-06-14 02:09:55 -04:00
Anonymous Maarten
ef6123886e
Add SDL_ReadS8 and SDL_WriteS8
2024-06-12 01:39:08 +02:00
Ryan C. Gordon
8ddf05855b
iostream: clarified SDL_IO_STATUS_READY documentation.
2024-06-09 13:21:31 -04:00
SDL Wiki Bot
9651ca5918
Sync SDL3 wiki -> header
2024-06-09 05:52:14 +00:00
Ryan C. Gordon
6110405c07
include: Fill in some documentation gaps.
2024-06-09 01:51:30 -04:00
Ryan C. Gordon
7d54a37d74
iostream: Make seeking's whence value a real enum.
2024-06-09 01:50:48 -04:00
Sam Lantinga
6f2621438a
Renamed DECLSPEC to SDL_DECLSPEC
2024-05-17 17:09:09 -07:00
Ryan C. Gordon
5e6d85b8f0
wikiheaders: bridge wiki Category docs to the headers!
...
Did an initial cleanup on the headers and wrote a few pieces of documentation,
but this needs more work to fill out the documentation.
2024-05-16 11:48:23 -04:00
Ryan C. Gordon
62a7e419f7
wikiheaders: Automatically categorize API symbols by subsystem.
2024-05-14 13:30:42 -04:00
SDL Wiki Bot
d7d3028765
Sync SDL3 wiki -> header
2024-05-06 16:06:32 +00:00
Miku AuahDark
33ae7e38d6
Android: Allow SDL_IOFromFile to open content:// URI. ( #9696 )
2024-05-06 09:05:49 -07:00
Ryan C. Gordon
9f842e9b5a
wikiheaders: Bind #defines below a function to it, like typedefs.
...
This effectively adds the property symbols for various functions to the
function's wiki page.
2024-05-02 12:49:30 -04:00
Nhalrath
8eeaa815d9
docs: rename num to size in SDL_iostream
2024-04-30 10:16:10 -07:00
Ryan C. Gordon
30970780a9
include: Fixed some old Doxygen markup to be Markdown instead.
2024-04-23 14:38:04 -04:00
SDL Wiki Bot
2c183c602d
Sync SDL3 wiki -> header
2024-04-17 21:09:29 +00:00
Ryan C. Gordon
a18f3d55b7
SDL_iostream.h: Corrected documentation for SDL_ReadIO and SDL_WriteIO.
...
Fixes #9443 .
2024-04-17 17:08:05 -04:00
Ryan C. Gordon
e044318a8e
Sync SDL3 wiki -> headers
2024-04-09 00:50:03 -04:00
Ryan C. Gordon
ad090d2444
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.
2024-04-09 00:50:02 -04:00
SDL Wiki Bot
b2682da035
Sync SDL3 wiki -> header
2024-03-19 04:57:27 +00:00
Sam Lantinga
24ec1c09b9
Renamed SDL_PROP_IOSTREAM_STDIO_HANDLE_POINTER to SDL_PROP_IOSTREAM_STDIO_FILE_POINTER
2024-03-18 21:56:11 -07:00
SDL Wiki Bot
fc26d5d328
Sync SDL3 wiki -> header
2024-03-18 04:28:30 +00:00
Sam Lantinga
a1a0156756
Renamed SDL_SizeIO() SDL_GetIOSize()
2024-03-18 00:27:18 -04:00
Sam Lantinga
df0f5deddf
Added SDL_IOFromDynamicMem()
2024-03-18 00:27:18 -04:00
Sam Lantinga
d8a54cd4f8
Updated "see also" references to be more consistent
...
Fixes https://github.com/libsdl-org/SDL/issues/9282
2024-03-17 12:28:11 -07:00
SDL Wiki Bot
fa7ec59ecd
Sync SDL3 wiki -> header
2024-03-15 19:59:26 +00:00
Ryan C. Gordon
b7cda16613
iostream: Final fixes before merging.
...
- SDL_GetRWProperties -> SDL_GetIOProperties
- SDL_GetRWStatus -> SDL_GetIOStatus
- Some documentation corrections and improvements.
2024-03-15 15:37:03 -04:00
Ryan C. Gordon
c175eb488c
iostream: Note that the new name has nothing to do with C++'s iostream class.
2024-03-15 01:16:31 -04:00
Ryan C. Gordon
5a21d87e69
rwops: Changed filenames that reference "rwops" to "iostream".
2024-03-14 23:30:59 -04:00
