Skip to content

Provide platform compatibility option in API documentation #12780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vittorioromeo opened this issue Apr 8, 2025 · 2 comments
Closed

Provide platform compatibility option in API documentation #12780

vittorioromeo opened this issue Apr 8, 2025 · 2 comments

Comments

@vittorioromeo
Copy link
Contributor

I couldn't find a part of the documentation which explicitly mentions what APIs are supported for a given platform. For example, how do I know if SDL_GetClipboardText is supported on Emscripten?

It would be nice to have some sort of table at the end of every function-specific documentation page, e.g.:

Android Emscripten FreeBSD Haiku OS iOS Linux macOS NetBSD Nintendo Switch Nintendo 3DS OpenBSD PlayStation 2 PlayStation 4 PlayStation 5 PlayStation Portable PlayStation Vita RISC OS SteamOS tvOS Windows Windows GDK Xbox
✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
@slouken
Copy link
Collaborator

slouken commented Apr 8, 2025

You should assume every API is available and always check for errors. Even if an API may not be supported now, it's likely to be added in a future version and users might drop in a new SDL library with fixes and improved support.

@slouken slouken closed this as not planned Won't fix, can't repro, duplicate, stale Apr 8, 2025
@vittorioromeo
Copy link
Contributor Author

You should assume every API is available and always check for errors

#9834 and #9819 would go a long way in helping!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants