search

H-uru / Plasma

Cyan Worlds's Plasma game engine
http://h-uru.github.io/Plasma/
GNU General Public License v3.0
205 stars 81 forks source link

Document SDL read/write options in more detail #1442

Closed dgelessus closed 1 year ago

dgelessus commented 1 year ago

The code that handles the SDL blob read/write options is quite tangled, so it's difficult to see which options do what exactly and where they even have any effect at all.

This PR adds detailed comments for all the options' meanings (for both reading and writing) and explicitly lists all the options understood by each method. Also some minor cleanup to the option passing, but not much - this is 90% a documentation change.

Deledrius commented 1 year ago

More code documentation is very appreciated!

dgelessus commented 1 year ago

That wasn't a logic change btw. kSkipNotificationInfo should behave the same way before and after my change. It just makes it clearer (IMO) what the flag does.